Base class for creating marker series in a IgxGeographicMap.Component

Constructors

Section titled "Constructors"

IgxGeographicMarkerSeriesComponent 

new IgxGeographicMarkerSeriesComponent(): IgxGeographicMarkerSeriesComponent

Returns IgxGeographicMarkerSeriesComponent

Properties

Section titled "Properties"

ngAcceptInputType_hasMarkers

Section titled "ngAcceptInputType_hasMarkers"

Inherited from: IgxGeographicMapSeriesHostComponent 

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_isGeographic

Section titled "ngAcceptInputType_isGeographic"

Inherited from: IgxGeographicMapSeriesHostComponent 

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_markerFillMode

Section titled "ngAcceptInputType_markerFillMode" 
ngAcceptInputType_markerFillMode: any

ngAcceptInputType_markerOutlineMode

Section titled "ngAcceptInputType_markerOutlineMode" 
ngAcceptInputType_markerOutlineMode: any

ngAcceptInputType_markerThickness

Section titled "ngAcceptInputType_markerThickness" 
ngAcceptInputType_markerThickness: string | number

ngAcceptInputType_markerType

Section titled "ngAcceptInputType_markerType" 
ngAcceptInputType_markerType: any

ngAcceptInputType_maximumMarkers

Section titled "ngAcceptInputType_maximumMarkers" 
ngAcceptInputType_maximumMarkers: string | number

ngAcceptInputType_visibleFromScale

Section titled "ngAcceptInputType_visibleFromScale"

Inherited from: IgxGeographicMapSeriesHostComponent 

ngAcceptInputType_visibleFromScale: string | number

ɵcmp

Section titled "ɵcmp" 
ɵcmp: ɵɵComponentDeclaration<IgxGeographicMarkerSeriesComponent, "ng-component", never, object, object, never, never, true, never>

ɵfac

Section titled "ɵfac" 
ɵfac: ɵɵFactoryDeclaration<IgxGeographicMarkerSeriesComponent, never>

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

coercionMethods

Section titled "coercionMethods"

Inherited from: IgxGeographicMapSeriesHostComponent

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

Gets whether this series supports markers

 
get hasMarkers(): boolean

Returns boolean

isGeographic

Section titled "isGeographic"

Inherited from: IgxGeographicMapSeriesHostComponent

Checks if this control is geographic coordinate system

 
get isGeographic(): boolean

Returns boolean

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

markerFillMode

Section titled "markerFillMode"

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"

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

maximumMarkers

Section titled "maximumMarkers"

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

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

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgxGeographicMapSeriesHostComponent

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgxGeographicMapSeriesHostComponent

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

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgxGeographicMapSeriesHostComponent

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgxGeographicMapSeriesHostComponent 

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

Parameters

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

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgxGeographicMapSeriesHostComponent

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

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

Called when this series' Style is updated.

 
styleUpdated(): void

Returns void