Class PointPair
A simple point represented by an (X,Y,Z) group of double values.
Implements
Inherited Members
Namespace: ZedGraph
Assembly: ZedGraph.dll
Syntax
[Serializable]
public class PointPair : PointPairBase, ISerializable, ICloneable
Constructors
| Improve this Doc View SourcePointPair()
Default Constructor
Declaration
public PointPair()
PointPair(Double, Double)
Creates a point pair with the specified X and Y.
Declaration
public PointPair(double x, double y)
Parameters
Type | Name | Description |
---|---|---|
System. |
x | This pair's x coordinate. |
System. |
y | This pair's y coordinate. |
PointPair(Double, Double, Double)
Creates a point pair with the specified X, Y, and base value.
Declaration
public PointPair(double x, double y, double z)
Parameters
Type | Name | Description |
---|---|---|
System. |
x | This pair's x coordinate. |
System. |
y | This pair's y coordinate. |
System. |
z | This pair's z or lower dependent coordinate. |
PointPair(Double, Double, Double, Object)
Creates a point pair with the specified X, Y, base value, and (Tag).
Declaration
public PointPair(double x, double y, double z, object tag)
Parameters
Type | Name | Description |
---|---|---|
System. |
x | This pair's x coordinate. |
System. |
y | This pair's y coordinate. |
System. |
z | This pair's z or lower dependent coordinate. |
System. |
tag | This pair's Tag property |
PointPair(Double, Double, Double, String)
Creates a point pair with the specified X, Y, base value, and string label (Tag).
Declaration
public PointPair(double x, double y, double z, string label)
Parameters
Type | Name | Description |
---|---|---|
System. |
x | This pair's x coordinate. |
System. |
y | This pair's y coordinate. |
System. |
z | This pair's z or lower dependent coordinate. |
System. |
label | This pair's string label (Tag) |
PointPair(Double, Double, String)
Creates a point pair with the specified X, Y, and label (Tag).
Declaration
public PointPair(double x, double y, string label)
Parameters
Type | Name | Description |
---|---|---|
System. |
x | This pair's x coordinate. |
System. |
y | This pair's y coordinate. |
System. |
label | This pair's string label (Tag) |
PointPair(PointF)
Creates a point pair from the specified System.
Declaration
public PointPair(PointF pt)
Parameters
Type | Name | Description |
---|---|---|
System. |
pt | The System. |
PointPair(SerializationInfo, StreamingContext)
Constructor for deserializing objects
Declaration
protected PointPair(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System. |
info | A System. |
System. |
context | A System. |
PointPair(PointPair)
The PointPair copy constructor.
Declaration
public PointPair(PointPair rhs)
Parameters
Type | Name | Description |
---|---|---|
Point |
rhs | The basis for the copy. |
Fields
| Improve this Doc View Sourceschema2
Current schema value that defines the version of the serialized file
Declaration
public const int schema2 = 11
Field Value
Type | Description |
---|---|
System. |
Tag
A tag object for use by the user. This can be used to store additional
information associated with the Point
Declaration
public object Tag
Field Value
Type | Description |
---|---|
System. |
Remarks
Note that, if you are going to Serialize ZedGraph data, then any type that you store in Tag must be a serializable type (or it will cause an exception).
Z
This PointPair's Z coordinate. Also used for the lower value (dependent axis)
for Hi
Declaration
public double Z
Field Value
Type | Description |
---|---|
System. |
Properties
| Improve this Doc View SourceColorValue
The ColorValue property is just an alias for the Z property.
Declaration
public virtual double ColorValue { get; set; }
Property Value
Type | Description |
---|---|
System. |
Remarks
For other types, such as the Stock
IsInvalid3D
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.
Declaration
public bool IsInvalid3D { get; }
Property Value
Type | Description |
---|---|
System. |
true if any value is invalid |
LowValue
The "low" value for this point (lower dependent-axis value). This is really just an alias for Z.
Declaration
public double LowValue { get; set; }
Property Value
Type | Description |
---|---|
System. |
The lower dependent value for this Point |
Methods
| Improve this Doc View SourceClone()
Typesafe, deep-copy clone method.
Declaration
public PointPair Clone()
Returns
Type | Description |
---|---|
Point |
A new, independent copy of this class |
Equals(Object)
Compare two Point
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System. |
obj | The Point |
Returns
Type | Description |
---|---|
System. |
true if the Point |
Overrides
| Improve this Doc View SourceGetHashCode()
Return the HashCode from the base class.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System. |
Overrides
| Improve this Doc View SourceGetObjectData(SerializationInfo, StreamingContext)
Populates a System.
Declaration
[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System. |
info | A System. |
System. |
context | A System. |
Overrides
| Improve this Doc View SourceToString(Boolean)
Format this PointPair value using the default format. Example: "( 12.345, -16.876 )". The two double values are formatted with the "g" format type.
Declaration
public virtual string ToString(bool isShowZ)
Parameters
Type | Name | Description |
---|---|---|
System. |
isShowZ | true to show the third "Z" or low dependent value coordinate |
Returns
Type | Description |
---|---|
System. |
A string representation of the PointPair |
ToString(String, Boolean)
Format this PointPair value using a general format string.
Example: a format string of "e2" would give "( 1.23e+001, -1.69e+001 )".
If
Declaration
public virtual string ToString(string format, bool isShowZ)
Parameters
Type | Name | Description |
---|---|---|
System. |
format | A format string that will be used to format each of
the two double type values (see System. |
System. |
isShowZ | true to show the third "Z" or low dependent value coordinate |
Returns
Type | Description |
---|---|
System. |
A string representation of the PointPair |
ToString(String, String, String)
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 )".
Declaration
public string ToString(string formatX, string formatY, string formatZ)
Parameters
Type | Name | Description |
---|---|---|
System. |
formatX | A format string that will be used to format the X
double type value (see System. |
System. |
formatY | A format string that will be used to format the Y
double type value (see System. |
System. |
formatZ | A format string that will be used to format the Z
double type value (see System. |
Returns
Type | Description |
---|---|
System. |
A string representation of the PointPair |
Explicit Interface Implementations
| Improve this Doc View SourceICloneable.Clone()
Implement the System.
Declaration
object ICloneable.Clone()
Returns
Type | Description |
---|---|
System. |
A deep copy of this object |