Base class for series which render polygons on a map.

Constructors

Section titled "Constructors"

IgrGeographicShapeSeriesBase 

new IgrGeographicShapeSeriesBase(props: P): IgrGeographicShapeSeriesBase

Returns IgrGeographicShapeSeriesBase

Accessors

Section titled "Accessors"

assigningShapeMarkerStyle

Section titled "assigningShapeMarkerStyle"

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"

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: IgrGeographicMapSeriesHost

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" 
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"

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"

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"

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: IgrGeographicMapSeriesHost

Gets whether this series supports markers

 
get hasMarkers(): boolean

Returns boolean

isCustomShapeMarkerStyleAllowed

Section titled "isCustomShapeMarkerStyleAllowed"

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"

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: IgrGeographicMapSeriesHost

Checks if this control is geographic coordinate system

 
get isGeographic(): boolean

Returns boolean

itemSearchMode

Section titled "itemSearchMode"

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"

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"

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

shapeDataSource

Section titled "shapeDataSource" 
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"

Set a shapefile datasource to use with the series.

 
get shapefileDataSource(): IgrShapeDataSource

Returns IgrShapeDataSource 

set shapefileDataSource(v: IgrShapeDataSource): void

Parameters

  • v: IgrShapeDataSource

Returns void

shapeFilterResolution

Section titled "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. 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"

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

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgrGeographicMapSeriesHost

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"

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

getItem

Section titled "getItem"

Inherited from: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost 

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrGeographicMapSeriesHost 

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

Parameters

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

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost

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: IgrGeographicMapSeriesHost

Called when this series' Style is updated.

 
styleUpdated(): void

Returns void