Class PointCollection

Inheritance

System.Object

PointCollection

Implements

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript.DataVisualization.Models

Assembly: Syncfusion.EJ.dll

Syntax

public class PointCollection : IList, ICollection, IEnumerable

Constructors

PointCollection()

Declaration

public PointCollection()

Properties

Count

Gets count of Point int the series.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Font

Gets or sets the font, which provides an option to customize the font color, weight, size, family and opacity.

Declaration

[JsonProperty("font")]
public object Font { get; set; }

Property Value

Type	Description
System.Object

Remarks

Options to customize font properties.

Interior

Declaration

[JsonProperty("interior")]
public string Interior { get; set; }

Property Value

Type	Description
System.String

IsEmpty

Declaration

[JsonProperty("isEmpty")]
public bool IsEmpty { get; set; }

Property Value

Type	Description
System.Boolean

IsReadOnly

Gets a value indicating whether the System.Collections.IList is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

Item[Int32]

Gets the with the specified x index.

Declaration

public Point this[int xIndex] { get; }

Parameters

Type	Name	Description
System.Int32	xIndex

Property Value

Type	Description
Point

Offset

Gets or sets the offset value, which provides an option to position the series data points based on offset value.

Declaration

[JsonProperty("offset")]
public int Offset { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Specifies offset value for point.

Shape

Gets or sets the shape, which specifies the marker shape in chart series data point to be rendered.

Declaration

[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("shape")]
public ChartShape Shape { get; set; }

Property Value

Type	Description
ChartShape

Remarks

Specifies the shape of point.

Style

Gets or sets the style, which provides an option to customize style of chart series data points.

Declaration

[JsonProperty("style")]
public object Style { get; set; }

Property Value

Type	Description
System.Object

Remarks

Specifies the style for point.

TemplateID

Gets or sets the template ID, which displays the div template based on provided ID in chart series data points.

Declaration

[JsonProperty("templateID")]
public string TemplateID { get; set; }

Property Value

Type	Description
System.String

Remarks

Specifies the template ID

Text

Declaration

[JsonProperty("text")]
public string Text { get; set; }

Property Value

Type	Description
System.String

Visible

Declaration

[JsonProperty("visible")]
public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean

VisibleOnLegend

Gets or sets the legend visibility value, which controls the visibility of legend items either to be visible or hidden.

Declaration

[JsonProperty("visibleOnLegend")]
[JsonConverter(typeof(StringEnumConverter))]
public VisibleOnLegend VisibleOnLegend { get; set; }

Property Value

Type	Description
VisibleOnLegend

Remarks

Enables or disables the legend items.

Methods

Add()

Declaration

public void Add()

Add(Object, Object)

Declaration

public void Add(object x, object y)

Parameters

Type	Name	Description
System.Object	x
System.Object	y

Add(Object, Object, Object)

Declaration

public void Add(object x, object high, object low)

Parameters

Type	Name	Description
System.Object	x
System.Object	high
System.Object	low

Add(Object, Object, Object, Object, Object)

Declaration

public void Add(object x, object high, object low, object open, object close)

Parameters

Type	Name	Description
System.Object	x
System.Object	high
System.Object	low
System.Object	open
System.Object	close

Clear()

Removes all the specified data points from each of the chart series.

Declaration

public void Clear()

GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	An IEnumerator object that can be used to iterate through the collection.

IndexOf(Point)

Returns index of a point.

Declaration

public int IndexOf(Point cp)

Parameters

Type	Name	Description
Point	cp	Instance of ChartPoint

Returns

Type	Description
System.Int32	The specified index of point.

Insert(Int32, Point)

Inserts a point to the series at the specified index.

Declaration

public void Insert(int xIndex, Point cp)

Parameters

Type	Name	Description
System.Int32	xIndex	Index of a point
Point	cp	Instance of ChartPoint

Remove(Point)

Removes the specified .

Declaration

public void Remove(Point cp)

Parameters

Type	Name	Description
Point	cp	The cp.

RemoveAt(Int32)

Removes the System.Collections.IList item at the specified index.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the item to remove.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	index is not a valid index in the System.Collections.IList.
System.NotSupportedException	The System.Collections.IList is read-only.-or- The System.Collections.IList has a fixed size.

ShouldSerializeFont()

Declaration

public bool ShouldSerializeFont()

Returns

Type	Description
System.Boolean

ShouldSerializeStyle()

Declaration

public bool ShouldSerializeStyle()

Returns

Type	Description
System.Boolean

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration

void ICollection.CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array	The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32	index	The zero-based index in array at which copying begins.

Exceptions

Type	Condition
System.ArgumentNullException	array is null.
System.ArgumentException	The type of the source System.Collections.ICollection cannot be cast automatically to the type of the destination array.
System.ArgumentOutOfRangeException	index is less than zero.
System.ArgumentException	array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source System.Collections.ICollection is greater than the available space from index to the end of the destination array.

ICollection.IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Declaration

bool ICollection.IsSynchronized { get; }

Returns

Type	Description
System.Boolean

ICollection.SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Declaration

object ICollection.SyncRoot { get; }

Returns

Type	Description
System.Object

IList.Add(Object)

Adds an item to the System.Collections.IList.

Declaration

int IList.Add(object value)

Parameters

Type	Name	Description
System.Object	value	The System.Object to add to the System.Collections.IList.

Returns

Type	Description
System.Int32	The position into which the new element was inserted.

Exceptions

Type	Condition
System.NotSupportedException	The System.Collections.IList is read-only.-or- The System.Collections.IList has a fixed size.

IList.Contains(Object)

Determines whether the System.Collections.IList contains a specific value.

Declaration

bool IList.Contains(object value)

Parameters

Type	Name	Description
System.Object	value	The System.Object to locate in the System.Collections.IList.

Returns

Type	Description
System.Boolean	true if the System.Object is found in the System.Collections.IList; otherwise, false.

IList.get_Item(Int32)

Declaration

object IList.get_Item(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Object

IList.IndexOf(Object)

Determines the index of a specific item in the System.Collections.IList.

Declaration

int IList.IndexOf(object value)

Parameters

Type	Name	Description
System.Object	value	The System.Object to locate in the System.Collections.IList.

Returns

Type	Description
System.Int32	The index of value if found in the list; otherwise, -1.

IList.Insert(Int32, Object)

Inserts an item to the System.Collections.IList at the specified index.

Declaration

void IList.Insert(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value	The System.Object to insert into the System.Collections.IList.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	index is not a valid index in the System.Collections.IList.
System.NotSupportedException	The System.Collections.IList is read-only.-or- The System.Collections.IList has a fixed size.
System.NullReferenceException	value is null reference in the System.Collections.IList.

IList.IsFixedSize

Gets a value indicating whether the System.Collections.IList has a fixed size.

Declaration

bool IList.IsFixedSize { get; }

Returns

Type	Description
System.Boolean

IList.Item[Int32]

Gets or sets the System.Object at the specified index.

Declaration

object IList.this[] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Object

IList.Remove(Object)

Removes the first occurrence of a specific object from the System.Collections.IList.

Declaration

void IList.Remove(object value)

Parameters

Type	Name	Description
System.Object	value	The System.Object to remove from the System.Collections.IList.

Exceptions

Type	Condition
System.NotSupportedException	The System.Collections.IList is read-only.-or- The System.Collections.IList has a fixed size.

IList.set_Item(Int32, Object)

Declaration

void IList.set_Item(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

Implements

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable