Series class which renders polygons as Paths, in a geographic context, based on lists of points in the ItemsSource.

Constructors

Section titled "Constructors"

IgrGeographicShapeSeries 

new IgrGeographicShapeSeries(props: IIgrGeographicShapeSeriesProps): IgrGeographicShapeSeries

Returns IgrGeographicShapeSeries

Accessors

Section titled "Accessors"

actualMarkerBrush

Section titled "actualMarkerBrush"

Gets the effective marker brush for the current series object.

 
get actualMarkerBrush(): string

Returns string 

set actualMarkerBrush(v: string): void

Parameters

  • v: string

Returns void

actualMarkerOutline

Section titled "actualMarkerOutline"

Gets the effective marker outline for the current series object.

 
get actualMarkerOutline(): string

Returns string 

set actualMarkerOutline(v: string): void

Parameters

  • v: string

Returns void

actualMarkerTemplate

Section titled "actualMarkerTemplate"

Gets the effective marker template for the current series object.

 
get actualMarkerTemplate(): IgDataTemplate

Returns IgDataTemplate 

set actualMarkerTemplate(v: IgDataTemplate): void

Parameters

  • v: IgDataTemplate

Returns void

assigningShapeMarkerStyle

Section titled "assigningShapeMarkerStyle"

Inherited from: IgrGeographicShapeSeriesBase

Event raised when Assigning Shape Marker Style

 
get assigningShapeMarkerStyle(): object

Returns object 

set assigningShapeMarkerStyle(ev: object): void

Parameters

  • ev: object

Returns void

assigningShapeStyle

Section titled "assigningShapeStyle"

Inherited from: IgrGeographicShapeSeriesBase

Event raised when Assigning Shape Style. Note, if using this event, or highlighting, its best to avoid use of ShapeStyle/StyleShape/ShapeStyleSelector.

 
get assigningShapeStyle(): object

Returns object 

set assigningShapeStyle(ev: object): void

Parameters

  • ev: object

Returns void

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrGeographicShapeSeriesBase

Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

 
get coercionMethods(): any

Returns any 

set coercionMethods(v: any): void

Parameters

  • v: any

Returns void

databaseSource

Section titled "databaseSource"

Inherited from: IgrGeographicShapeSeriesBase 

get databaseSource(): string

Returns string

Gets or sets the string path of the .dbf portion of the Shapefile.

 
set databaseSource(value: string): void

Parameters

  • value: string

Returns void

fillMemberPath

Section titled "fillMemberPath"

Inherited from: IgrGeographicShapeSeriesBase

Gets or sets the fill mapping property for the current series object.

 
get fillMemberPath(): string

Returns string 

set fillMemberPath(v: string): void

Parameters

  • v: string

Returns void

fillScale

Section titled "fillScale"

Inherited from: IgrGeographicShapeSeriesBase

Gets or sets the brush scale for the fill brush of markers.

 
get fillScale(): IgrBrushScale

Returns IgrBrushScale 

set fillScale(v: IgrBrushScale): void

Parameters

  • v: IgrBrushScale

Returns void

fillScaleUseGlobalValues

Section titled "fillScaleUseGlobalValues"

Inherited from: IgrGeographicShapeSeriesBase

Gets or sets whether or not the FillScale uses global min/max values of FillMemberPath from multiple series. This setting applies only if multiple series are using the same FillScale.

 
get fillScaleUseGlobalValues(): boolean

Returns boolean 

set fillScaleUseGlobalValues(v: boolean): void

Parameters

  • v: boolean

Returns void

hasMarkers

Section titled "hasMarkers"

Inherited from: IgrGeographicShapeSeriesBase

Gets whether this series supports markers

 
get hasMarkers(): boolean

Returns boolean

isCustomShapeMarkerStyleAllowed

Section titled "isCustomShapeMarkerStyleAllowed"

Inherited from: IgrGeographicShapeSeriesBase

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

 
get isCustomShapeMarkerStyleAllowed(): boolean

Returns boolean 

set isCustomShapeMarkerStyleAllowed(v: boolean): void

Parameters

  • v: boolean

Returns void

isCustomShapeStyleAllowed

Section titled "isCustomShapeStyleAllowed"

Inherited from: IgrGeographicShapeSeriesBase

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

 
get isCustomShapeStyleAllowed(): boolean

Returns boolean 

set isCustomShapeStyleAllowed(v: boolean): void

Parameters

  • v: boolean

Returns void

isGeographic

Section titled "isGeographic"

Inherited from: IgrGeographicShapeSeriesBase

Checks if this control is geographic coordinate system

 
get isGeographic(): boolean

Returns boolean

isPolygon

Section titled "isPolygon"

Gets whether the current series shows a polygon shape.

 
get isPolygon(): boolean

Returns boolean

itemSearchMode

Section titled "itemSearchMode"

Inherited from: IgrGeographicShapeSeriesBase

Gets or sets the mode the series will use to find the closest point to the cursor.

 
get itemSearchMode(): ShapeItemSearchMode

Returns ShapeItemSearchMode 

set itemSearchMode(v: ShapeItemSearchMode): void

Parameters

  • v: ShapeItemSearchMode

Returns void

itemSearchPointsThreshold

Section titled "itemSearchPointsThreshold"

Inherited from: IgrGeographicShapeSeriesBase

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

 
get itemSearchPointsThreshold(): number

Returns number 

set itemSearchPointsThreshold(v: number): void

Parameters

  • v: number

Returns void

itemSearchThreshold

Section titled "itemSearchThreshold"

Inherited from: IgrGeographicShapeSeriesBase

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

 
get itemSearchThreshold(): number

Returns number 

set itemSearchThreshold(v: number): void

Parameters

  • v: number

Returns void

markerBrush

Section titled "markerBrush"

Gets or sets the brush that specifies how the current series object's marker interiors are painted.

 
get markerBrush(): string

Returns string 

set markerBrush(v: string): void

Parameters

  • v: string

Returns void

markerCollisionAvoidance

Section titled "markerCollisionAvoidance"

The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision.

 
get markerCollisionAvoidance(): CollisionAvoidanceType

Returns CollisionAvoidanceType 

set markerCollisionAvoidance(v: CollisionAvoidanceType): void

Parameters

  • v: CollisionAvoidanceType

Returns void

markerFillMode

Section titled "markerFillMode"

Gets or sets whether the marker brush is based on the marker outline of the series rather than the marker brushes collection.

 
get markerFillMode(): MarkerFillMode

Returns MarkerFillMode 

set markerFillMode(v: MarkerFillMode): void

Parameters

  • v: MarkerFillMode

Returns void

markerOutline

Section titled "markerOutline"

Gets or sets the brush that specifies how the current series object's marker outlines are painted.

 
get markerOutline(): string

Returns string 

set markerOutline(v: string): void

Parameters

  • v: string

Returns void

markerOutlineMode

Section titled "markerOutlineMode"

Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

 
get markerOutlineMode(): MarkerOutlineMode

Returns MarkerOutlineMode 

set markerOutlineMode(v: MarkerOutlineMode): void

Parameters

  • v: MarkerOutlineMode

Returns void

markerTemplate

Section titled "markerTemplate"

Gets or sets the MarkerTemplate for the current series object.

 
get markerTemplate(): IgDataTemplate

Returns IgDataTemplate 

set markerTemplate(v: IgDataTemplate): void

Parameters

  • v: IgDataTemplate

Returns void

markerThickness

Section titled "markerThickness"

Gets or sets thickness of the marker outline

 
get markerThickness(): number

Returns number 

set markerThickness(v: number): void

Parameters

  • v: number

Returns void

markerType

Section titled "markerType"

Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

 
get markerType(): MarkerType

Returns MarkerType 

set markerType(v: MarkerType): void

Parameters

  • v: MarkerType

Returns void

shapeDataSource

Section titled "shapeDataSource"

Inherited from: IgrGeographicShapeSeriesBase 

get shapeDataSource(): string

Returns string

Gets or sets the string path of the .shp portion of the Shapefile.

 
set shapeDataSource(value: string): void

Parameters

  • value: string

Returns void

shapefileDataSource

Section titled "shapefileDataSource"

Inherited from: IgrGeographicShapeSeriesBase

Set a shapefile datasource to use with the series.

 
get shapefileDataSource(): IgrShapeDataSource

Returns IgrShapeDataSource 

set shapefileDataSource(v: IgrShapeDataSource): void

Parameters

  • v: IgrShapeDataSource

Returns void

shapeFill

Section titled "shapeFill"

Gets or sets the fill brush.

 
get shapeFill(): string

Returns string 

set shapeFill(v: string): void

Parameters

  • v: string

Returns void

shapeFilterResolution

Section titled "shapeFilterResolution"

Inherited from: IgrGeographicShapeSeriesBase

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. In the case of GeographicPolylineSeries, 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.

 
get shapeFilterResolution(): number

Returns number 

set shapeFilterResolution(v: number): void

Parameters

  • v: number

Returns void

shapeMemberPath

Section titled "shapeMemberPath"

Inherited from: IgrGeographicShapeSeriesBase

The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. 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.

 
get shapeMemberPath(): string

Returns string 

set shapeMemberPath(v: string): void

Parameters

  • v: string

Returns void

shapeOpacity

Section titled "shapeOpacity"

Gets or sets the opacity.

 
get shapeOpacity(): number

Returns number 

set shapeOpacity(v: number): void

Parameters

  • v: number

Returns void

shapeStroke

Section titled "shapeStroke"

Gets or sets the stroke brush.

 
get shapeStroke(): string

Returns string 

set shapeStroke(v: string): void

Parameters

  • v: string

Returns void

shapeStrokeThickness

Section titled "shapeStrokeThickness"

Gets or sets the stroke thickness.

 
get shapeStrokeThickness(): number

Returns number 

set shapeStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

styleShape

Section titled "styleShape" 
get styleShape(): object

Returns object 

set styleShape(ev: object): void

Parameters

  • ev: object

Returns void

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgrGeographicShapeSeriesBase

The minimum scale at which this series becomes visible. The default value for this property is 1.0, which means the series will always be visible. At a VisibleFromScale setting of 0.0, the series will never be visible. At a VisibleFromScale setting of 0.5, the series will be visible as long as the map is zoomed in to at least 200%.

 
get visibleFromScale(): number

Returns number 

set visibleFromScale(v: number): void

Parameters

  • v: number

Returns void

Methods

Section titled "Methods"

ensureShapeStyle

Section titled "ensureShapeStyle" 
ensureShapeStyle(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrGeographicShapeSeriesBase 

findByName(name: string): any

Parameters

  • name: string

Returns any

getItem

Section titled "getItem"

Inherited from: IgrGeographicShapeSeriesBase

Gets the item that is the best match for the specified world coordinates.

 
getItem(world: IgPoint): any

Parameters

  • world: IgPoint
    • The world coordinates to use.

Returns any

getItemSpan

Section titled "getItemSpan"

Inherited from: IgrGeographicShapeSeriesBase

For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

 
getItemSpan(): number

Returns number

getItemValue

Section titled "getItemValue"

Inherited from: IgrGeographicShapeSeriesBase 

getItemValue(item: any, memberPathName: string): any

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgrGeographicShapeSeriesBase

Gets the value of a requested member path from the series.

 
getMemberPathValue(memberPathName: string): string

Parameters

  • memberPathName: string
    • The property name of a valid member path for the series

Returns string

getNextOrExactIndex

Section titled "getNextOrExactIndex"

Inherited from: IgrGeographicShapeSeriesBase 

getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgrGeographicShapeSeriesBase 

getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgrGeographicShapeSeriesBase

If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

 
getSeriesValueBoundingBox(world: IgPoint): IgRect

Parameters

  • world: IgPoint
    • The world coordinate for which to get a value bounding box for

Returns IgRect

getSeriesValueFromSeriesPixel

Section titled "getSeriesValueFromSeriesPixel"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgrGeographicShapeSeriesBase

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.

 
getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect

Parameters

  • world: IgPoint
    • The world coordinates for which to get a value marker bounding box for

Returns IgRect

getSeriesValuePosition

Section titled "getSeriesValuePosition"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrGeographicShapeSeriesBase 

getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgrGeographicShapeSeriesBase

Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

 
notifyIndexedPropertiesChanged(): void

Returns void

renderSeries

Section titled "renderSeries"

Inherited from: IgrGeographicShapeSeriesBase

Renders the series.

 
renderSeries(animate: boolean): void

Parameters

  • animate: boolean
    • True if the change should be animated.

Returns void

styleUpdated

Section titled "styleUpdated"

Inherited from: IgrGeographicShapeSeriesBase

Called when this series' Style is updated.

 
styleUpdated(): void

Returns void