Class IgbScatterBase
Represents the base class for all IgbDataChart scatter series
Inheritance
System.Object
IgbScatterBase
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbScatterBase : IgbMarkerSeries, JsonSerializable, IDisposable
Constructors
IgbScatterBase()
Declaration
Properties
ActualItemSearchMode
Declaration
public ScatterItemSearchMode ActualItemSearchMode { get; set; }
Property Value
ActualTrendLineBrush
Gets the effective TrendLineBrush for this series.
Declaration
public string ActualTrendLineBrush { get; set; }
Property Value
Type |
Description |
System.String |
|
AssigningScatterMarkerStyle
Declaration
public Action<IgbAssigningScatterMarkerStyleEventArgs> AssigningScatterMarkerStyle { get; set; }
Property Value
AssigningScatterMarkerStyleScript
Declaration
public string AssigningScatterMarkerStyleScript { get; set; }
Property Value
Type |
Description |
System.String |
|
AssigningScatterStyle
Declaration
public Action<IgbAssigningScatterStyleEventArgs> AssigningScatterStyle { get; set; }
Property Value
AssigningScatterStyleScript
Declaration
public string AssigningScatterStyleScript { get; set; }
Property Value
Type |
Description |
System.String |
|
IsCustomScatterMarkerStyleAllowed
Gets or sets whether this Scatter series should allow custom style overrides of its individual marker visuals.
Declaration
public bool IsCustomScatterMarkerStyleAllowed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsCustomScatterStyleAllowed
Gets or sets whether this Scatter series should allow custom style overrides of its individual visuals.
Declaration
public bool IsCustomScatterStyleAllowed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ItemSearchMode
Gets or sets the mode the series will use to find the closest point to the cursor.
Declaration
public ScatterItemSearchMode ItemSearchMode { get; set; }
Property Value
ItemSearchThreshold
Gets or sets the threshold to use when searching for items using ItemSearchMode.
Declaration
public int ItemSearchThreshold { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
MarkerCollisionAvoidance
The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision.
Declaration
public CollisionAvoidanceType MarkerCollisionAvoidance { get; set; }
Property Value
MaximumMarkers
Gets or sets the maximum number of markerItems displayed by the current series.
If more than the specified number of markerItems are visible, the series will automatically
choose a representative set.
Declaration
public int MaximumMarkers { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
TrendLineBrush
Gets or sets the brush to use to draw the trend line.
Declaration
public string TrendLineBrush { get; set; }
Property Value
Type |
Description |
System.String |
|
TrendLinePeriod
Gets or sets the moving average period for the current scatter series object.
Declaration
public int TrendLinePeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
TrendLineThickness
Gets or sets the thickness of the current scatter series object's trend line.
Declaration
public double TrendLineThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
TrendLineType
Gets or sets the trend type for the current scatter series.
Declaration
public TrendLineType TrendLineType { get; set; }
Property Value
TrendLineZIndex
Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data.
Declaration
public int TrendLineZIndex { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
XAxis
Gets or sets the effective x-axis for the current object.
Declaration
public IgbNumericXAxis XAxis { get; set; }
Property Value
XAxisName
Gets or sets the name to use to resolve xAxis from markup.
Declaration
public string XAxisName { get; set; }
Property Value
Type |
Description |
System.String |
|
XAxisScript
Provides a means of setting XAxis in the JavaScript environment.
Declaration
public string XAxisScript { get; set; }
Property Value
Type |
Description |
System.String |
|
XMemberAsLegendLabel
Gets or sets the label displayed before series X value in the Data Legend.
Declaration
public string XMemberAsLegendLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
XMemberAsLegendUnit
Gets or sets the unit after displayed after series X value in the Data Legend.
Declaration
public string XMemberAsLegendUnit { get; set; }
Property Value
Type |
Description |
System.String |
|
XMemberPath
Gets or sets the value mapping property for the current series object.
Declaration
public string XMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
YAxis
Gets or sets the effective y-axis for the current object.
Declaration
public IgbNumericYAxis YAxis { get; set; }
Property Value
YAxisName
Gets or sets the name to use to resolve yAxis from markup.
Declaration
public string YAxisName { get; set; }
Property Value
Type |
Description |
System.String |
|
YAxisScript
Provides a means of setting YAxis in the JavaScript environment.
Declaration
public string YAxisScript { get; set; }
Property Value
Type |
Description |
System.String |
|
YMemberAsLegendLabel
Gets or sets the label displayed before series Y value in the Data Legend.
Declaration
public string YMemberAsLegendLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
YMemberAsLegendUnit
Gets or sets the unit after displayed after series Y value in the Data Legend.
Declaration
public string YMemberAsLegendUnit { get; set; }
Property Value
Type |
Description |
System.String |
|
YMemberPath
Gets or sets the value mapping property for the current series object.
Declaration
public string YMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
BindAxes(IgbAxis[])
Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
Type |
Name |
Description |
IgbAxis[] |
Axes |
|
Overrides
CanUseAsXAxis(Object)
Declaration
public bool CanUseAsXAxis(object axis)
Parameters
Type |
Name |
Description |
System.Object |
axis |
|
Returns
Type |
Description |
System.Boolean |
|
CanUseAsXAxisAsync(Object)
Determine if object can be used as XAxis
Declaration
public Task<bool> CanUseAsXAxisAsync(object axis)
Parameters
Type |
Name |
Description |
System.Object |
axis |
The object to check
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Boolean> |
|
CanUseAsYAxis(Object)
Declaration
public bool CanUseAsYAxis(object axis)
Parameters
Type |
Name |
Description |
System.Object |
axis |
|
Returns
Type |
Description |
System.Boolean |
|
CanUseAsYAxisAsync(Object)
Determine if object can be used as YAxis
Declaration
public Task<bool> CanUseAsYAxisAsync(object axis)
Parameters
Type |
Name |
Description |
System.Object |
axis |
The object to check
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Boolean> |
|
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetExactItemIndex(Point)
Declaration
public override double GetExactItemIndex(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Type |
Description |
System.Double |
|
Overrides
GetExactItemIndexAsync(Point)
Declaration
public override Task<double> GetExactItemIndexAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Double> |
|
Overrides
GetItem(Point)
Declaration
public override object GetItem(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetItemAsync(Point)
Gets the item that is the best match for the specified world coordinates.
Declaration
public override Task<object> GetItemAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
The world coordinates to use.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
Overrides
GetItemIndex(Point)
Declaration
public override int GetItemIndex(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Type |
Description |
System.Int32 |
|
Overrides
GetItemIndexAsync(Point)
Gets the index of the item that resides at the provided world coordinates.
Declaration
public override Task<int> GetItemIndexAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
The world coordinates of the requested item.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Int32> |
|
Overrides
GetItemValue(Object, String)
Declaration
public override object GetItemValue(object item, string memberPathName)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.String |
memberPathName |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetItemValueAsync(Object, String)
Declaration
public override Task<object> GetItemValueAsync(object item, string memberPathName)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.String |
memberPathName |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
Overrides
GetSeriesValueMarkerBoundingBox(Point)
Declaration
public override Rect GetSeriesValueMarkerBoundingBox(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Overrides
GetSeriesValueMarkerBoundingBoxAsync(Point)
If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.
Declaration
public override Task<Rect> GetSeriesValueMarkerBoundingBoxAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
The world coordinates for which to get a value marker bounding box for
|
Returns
Type |
Description |
System.Threading.Tasks.Task<Rect> |
|
Overrides
GetSeriesValuePosition(Point, Boolean, Boolean)
Declaration
public override Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type |
Name |
Description |
Point |
world |
|
System.Boolean |
useInterpolation |
|
System.Boolean |
skipUnknowns |
|
Returns
Overrides
GetSeriesValuePositionAsync(Point, Boolean, Boolean)
Declaration
public override Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type |
Name |
Description |
Point |
world |
|
System.Boolean |
useInterpolation |
|
System.Boolean |
skipUnknowns |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<Point> |
|
Overrides
Declaration
public override bool ScrollIntoView(object item)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
Scrolls the series to display the item for the specified data item.
Declaration
public override Task<bool> ScrollIntoViewAsync(object item)
Parameters
Type |
Name |
Description |
System.Object |
item |
The data item (item) to scroll to.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Boolean> |
|
Overrides
Implements
System.IDisposable