Series class for a geographic map with points marked at given locations. This is the geographic equivalent of a ScatterSeries.

Constructors

Section titled "Constructors"

IgrGeographicSymbolSeries 

new IgrGeographicSymbolSeries(props: IIgrGeographicSymbolSeriesProps): IgrGeographicSymbolSeries

Returns IgrGeographicSymbolSeries

Accessors

Section titled "Accessors"

actualMarkerBrush

Section titled "actualMarkerBrush"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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

assigningScatterMarkerStyle

Section titled "assigningScatterMarkerStyle"

Event raised when Assigning Scatter Marker Style

 
get assigningScatterMarkerStyle(): object

Returns object 

set assigningScatterMarkerStyle(ev: object): void

Parameters

  • ev: object

Returns void

assigningScatterStyle

Section titled "assigningScatterStyle"

Event raised when Assigning Category Style

 
get assigningScatterStyle(): object

Returns object 

set assigningScatterStyle(ev: object): void

Parameters

  • ev: object

Returns void

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrGeographicMarkerSeries

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

hasMarkers

Section titled "hasMarkers"

Inherited from: IgrGeographicMarkerSeries

Gets whether this series supports markers

 
get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Section titled "hasOnlyMarkers"

Gets whether the series has only marker as visuals

 
get hasOnlyMarkers(): boolean

Returns boolean

isCustomScatterMarkerStyleAllowed

Section titled "isCustomScatterMarkerStyleAllowed"

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

 
get isCustomScatterMarkerStyleAllowed(): boolean

Returns boolean 

set isCustomScatterMarkerStyleAllowed(v: boolean): void

Parameters

  • v: boolean

Returns void

isCustomScatterStyleAllowed

Section titled "isCustomScatterStyleAllowed"

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

 
get isCustomScatterStyleAllowed(): boolean

Returns boolean 

set isCustomScatterStyleAllowed(v: boolean): void

Parameters

  • v: boolean

Returns void

isGeographic

Section titled "isGeographic"

Inherited from: IgrGeographicMarkerSeries

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(): ScatterItemSearchMode

Returns ScatterItemSearchMode 

set itemSearchMode(v: ScatterItemSearchMode): void

Parameters

  • v: ScatterItemSearchMode

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

latitudeMemberPath

Section titled "latitudeMemberPath"

The name of the property of ItemsSource items which contains the latitude coordinate of the symbol.

 
get latitudeMemberPath(): string

Returns string 

set latitudeMemberPath(v: string): void

Parameters

  • v: string

Returns void

longitudeMemberPath

Section titled "longitudeMemberPath"

The name of the property of ItemsSource items which contains the longitude coordinate of the symbol.

 
get longitudeMemberPath(): string

Returns string 

set longitudeMemberPath(v: string): void

Parameters

  • v: string

Returns void

markerBrush

Section titled "markerBrush"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

Gets or sets whether the marker fill 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"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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"

Inherited from: IgrGeographicMarkerSeries

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

maximumMarkers

Section titled "maximumMarkers"

Inherited from: IgrGeographicMarkerSeries

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.

 
get maximumMarkers(): number

Returns number 

set maximumMarkers(v: number): void

Parameters

  • v: number

Returns void

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgrGeographicMarkerSeries

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"

getItem

Section titled "getItem"

Inherited from: IgrGeographicMarkerSeries

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgrGeographicMarkerSeries

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgrGeographicMarkerSeries

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

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgrGeographicMarkerSeries

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgrGeographicMarkerSeries 

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

Parameters

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

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgrGeographicMarkerSeries

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

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

Called when this series' Style is updated.

 
styleUpdated(): void

Returns void