Series class used for displaying multiple polylines, in a geographic context, for datasources which contain multiple lists of points.

Constructors

Section titled "Constructors"

IgxGeographicPolylineSeriesComponent 

new IgxGeographicPolylineSeriesComponent(): IgxGeographicPolylineSeriesComponent

Returns IgxGeographicPolylineSeriesComponent

Properties

Section titled "Properties"

ngAcceptInputType_fillScaleUseGlobalValues

Section titled "ngAcceptInputType_fillScaleUseGlobalValues"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_fillScaleUseGlobalValues: string | boolean

ngAcceptInputType_hasMarkers

Section titled "ngAcceptInputType_hasMarkers"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_isCustomShapeMarkerStyleAllowed

Section titled "ngAcceptInputType_isCustomShapeMarkerStyleAllowed"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_isCustomShapeMarkerStyleAllowed: string | boolean

ngAcceptInputType_isCustomShapeStyleAllowed

Section titled "ngAcceptInputType_isCustomShapeStyleAllowed"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_isCustomShapeStyleAllowed: string | boolean

ngAcceptInputType_isGeographic

Section titled "ngAcceptInputType_isGeographic"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_isPolyline

Section titled "ngAcceptInputType_isPolyline" 
ngAcceptInputType_isPolyline: string | boolean

ngAcceptInputType_itemSearchMode

Section titled "ngAcceptInputType_itemSearchMode"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_itemSearchMode: any

ngAcceptInputType_itemSearchPointsThreshold

Section titled "ngAcceptInputType_itemSearchPointsThreshold"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_itemSearchPointsThreshold: string | number

ngAcceptInputType_itemSearchThreshold

Section titled "ngAcceptInputType_itemSearchThreshold"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_itemSearchThreshold: string | number

ngAcceptInputType_shapeFilterResolution

Section titled "ngAcceptInputType_shapeFilterResolution"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_shapeFilterResolution: string | number

ngAcceptInputType_shapeOpacity

Section titled "ngAcceptInputType_shapeOpacity" 
ngAcceptInputType_shapeOpacity: string | number

ngAcceptInputType_shapeStrokeThickness

Section titled "ngAcceptInputType_shapeStrokeThickness" 
ngAcceptInputType_shapeStrokeThickness: string | number

ngAcceptInputType_visibleFromScale

Section titled "ngAcceptInputType_visibleFromScale"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

ngAcceptInputType_visibleFromScale: string | number

ɵcmp

Section titled "ɵcmp" 
ɵcmp: ɵɵComponentDeclaration<IgxGeographicPolylineSeriesComponent, "igx-geographic-polyline-series", never, object, object, never, never, true, never>

ɵfac

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

Accessors

Section titled "Accessors"

assigningShapeMarkerStyle

Section titled "assigningShapeMarkerStyle"

Inherited from: IgxGeographicShapeSeriesBaseComponent

Event raised when Assigning Shape Marker Style

 
get assigningShapeMarkerStyle(): EventEmitter<object>

Returns EventEmitter<object>

assigningShapeStyle

Section titled "assigningShapeStyle"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

 
get assigningShapeStyle(): EventEmitter<object>

Returns EventEmitter<object>

coercionMethods

Section titled "coercionMethods"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

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

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

 
get fillScale(): IgxBrushScaleComponent

Returns IgxBrushScaleComponent 

set fillScale(v: IgxBrushScaleComponent): void

Parameters

  • v: IgxBrushScaleComponent

Returns void

fillScaleUseGlobalValues

Section titled "fillScaleUseGlobalValues"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

Gets whether this series supports markers

 
get hasMarkers(): boolean

Returns boolean

isCustomShapeMarkerStyleAllowed

Section titled "isCustomShapeMarkerStyleAllowed"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

Checks if this control is geographic coordinate system

 
get isGeographic(): boolean

Returns boolean

isPolyline

Section titled "isPolyline"

Gets whether the current series shows a polyline shape.

 
get isPolyline(): boolean

Returns boolean

itemSearchMode

Section titled "itemSearchMode"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

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"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Set a shapefile datasource to use with the series.

 
get shapefileDataSource(): IgxShapeDataSource

Returns IgxShapeDataSource 

set shapefileDataSource(v: IgxShapeDataSource): void

Parameters

  • v: IgxShapeDataSource

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

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

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(): EventEmitter<object>

Returns EventEmitter<object>

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

findByName(name: string): any

Parameters

  • name: string

Returns any

getItem

Section titled "getItem"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgxGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgxGeographicShapeSeriesBaseComponent

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

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

Called when this series' Style is updated.

 
styleUpdated(): void

Returns void

register

Section titled "register" 
register(): void

Returns void