Base class for creating marker series in a GeographicMap.Component

Constructors

Section titled "Constructors"

IgrGeographicMarkerSeries

new IgrGeographicMarkerSeries(props: P): IgrGeographicMarkerSeries

Returns IgrGeographicMarkerSeries

Properties

Section titled "Properties"

actualMarkerBrush

Section titled "actualMarkerBrush" 
actualMarkerBrush: string

actualMarkerOutline

Section titled "actualMarkerOutline" 
actualMarkerOutline: string

actualMarkerTemplate

Section titled "actualMarkerTemplate" 
actualMarkerTemplate: IgDataTemplate

coercionMethods

Section titled "coercionMethods"

Inherited from: IgrGeographicMapSeriesHost 

coercionMethods: any

markerBrush

Section titled "markerBrush" 
markerBrush: string

markerFillMode

Section titled "markerFillMode" 
markerFillMode: MarkerFillMode

markerOutline

Section titled "markerOutline" 
markerOutline: string

markerOutlineMode

Section titled "markerOutlineMode" 
markerOutlineMode: MarkerOutlineMode

markerTemplate

Section titled "markerTemplate" 
markerTemplate: IgDataTemplate

markerThickness

Section titled "markerThickness" 
markerThickness: number

markerType

Section titled "markerType" 
markerType: MarkerType

maximumMarkers

Section titled "maximumMarkers" 
maximumMarkers: number

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgrGeographicMapSeriesHost 

visibleFromScale: number

Accessors

Section titled "Accessors"

hasMarkers

Section titled "hasMarkers"

Inherited from: IgrGeographicMapSeriesHost

Gets whether this series supports markers

get hasMarkers(): boolean

Returns boolean

isGeographic

Section titled "isGeographic"

Inherited from: IgrGeographicMapSeriesHost

Checks if this control is geographic coordinate system

get isGeographic(): boolean

Returns boolean

Methods

Section titled "Methods"

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