Class IgbShapeSeriesBase

Series class for rendering polygons.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbShapeSeriesBase
IgbScatterPolygonSeries
IgbScatterPolylineSeries
IgbTileSeries
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbShapeSeriesBase : IgbSeries, JsonSerializable, IDisposable

Constructors

IgbShapeSeriesBase()

Declaration
public IgbShapeSeriesBase()

Properties

ActualItemSearchMode

Declaration
public ShapeItemSearchMode ActualItemSearchMode { get; set; }
Property Value
Type Description
ShapeItemSearchMode

AssigningShapeMarkerStyle

Declaration
public Action<IgbAssigningShapeMarkerStyleEventArgs> AssigningShapeMarkerStyle { get; set; }
Property Value
Type Description
System.Action<IgbAssigningShapeMarkerStyleEventArgs>

AssigningShapeMarkerStyleScript

Declaration
public string AssigningShapeMarkerStyleScript { get; set; }
Property Value
Type Description
System.String

AssigningShapeStyle

Declaration
public Action<IgbAssigningShapeStyleEventArgs> AssigningShapeStyle { get; set; }
Property Value
Type Description
System.Action<IgbAssigningShapeStyleEventArgs>

AssigningShapeStyleScript

Declaration
public string AssigningShapeStyleScript { get; set; }
Property Value
Type Description
System.String

FillMemberPath

Declaration
public string FillMemberPath { get; set; }
Property Value
Type Description
System.String

FillScale

Declaration
public IgbBrushScale FillScale { get; set; }
Property Value
Type Description
IgbBrushScale

FillScaleUseGlobalValues

Declaration
public bool FillScaleUseGlobalValues { get; set; }
Property Value
Type Description
System.Boolean

HighlightedShapeMemberPath

Declaration
public string HighlightedShapeMemberPath { get; set; }
Property Value
Type Description
System.String

IsCustomShapeMarkerStyleAllowed

Gets or sets whether this Shape series should allow custom style overrides of its individual marker visuals.

Declaration
public bool IsCustomShapeMarkerStyleAllowed { get; set; }
Property Value
Type Description
System.Boolean

IsCustomShapeStyleAllowed

Gets or sets whether this Shape series should allow custom style overrides of its individual visuals.

Declaration
public bool IsCustomShapeStyleAllowed { 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 ShapeItemSearchMode ItemSearchMode { get; set; }
Property Value
Type Description
ShapeItemSearchMode

ItemSearchPointsThreshold

Gets or sets the points threshold to use when searching for items using ItemSearchMode.

Declaration
public int ItemSearchPointsThreshold { get; set; }
Property Value
Type Description
System.Int32

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

ShapeFilterResolution

The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out.

Declaration
public double ShapeFilterResolution { get; set; }
Property Value
Type Description
System.Double
Remarks

In the case of ScatterPolylineSeries, the resolution is compared to either dimension, rather than both. In other words, a polyline will not be filtered if its height or its width exceeds the value of this property. Whereas with a ShapeSeries, both the height and the width must exceed the value of this property.

ShapeMemberPath

The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon.

Declaration
public string ShapeMemberPath { get; set; }
Property Value
Type Description
System.String
Remarks

To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points.

StyleShape

Declaration
public Action<IgbStyleShapeEventArgs> StyleShape { get; set; }
Property Value
Type Description
System.Action<IgbStyleShapeEventArgs>

StyleShapeScript

Declaration
public string StyleShapeScript { get; set; }
Property Value
Type Description
System.String

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 ScatterBase object.

Declaration
public IgbNumericXAxis XAxis { get; set; }
Property Value
Type Description
IgbNumericXAxis

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

YAxis

Gets or sets the effective y-axis for the current ScatterBase object.

Declaration
public IgbNumericYAxis YAxis { get; set; }
Property Value
Type Description
IgbNumericYAxis

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

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

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

GetMemberPathValue(String)

Declaration
public override string GetMemberPathValue(string memberPathName)
Parameters
Type Name Description
System.String memberPathName
Returns
Type Description
System.String
Overrides

GetMemberPathValueAsync(String)

Declaration
public override Task<string> GetMemberPathValueAsync(string memberPathName)
Parameters
Type Name Description
System.String memberPathName
Returns
Type Description
System.Threading.Tasks.Task<System.String>
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
Type Description
Point
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

Implements

System.IDisposable