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: ɵɵComponentDeclaration<IgxGeographicPolylineSeriesComponent, "igx-geographic-polyline-series", never, object, object, never, never> ɵfac: ɵɵFactoryDeclaration<IgxGeographicPolylineSeriesComponent, never> coercionMethods
Section titled "coercionMethods"Inherited from: IgxGeographicShapeSeriesBaseComponent
coercionMethods: any databaseSource
Section titled "databaseSource"Inherited from: IgxGeographicShapeSeriesBaseComponent
databaseSource: string fillMemberPath
Section titled "fillMemberPath"Inherited from: IgxGeographicShapeSeriesBaseComponent
fillMemberPath: string fillScale
Section titled "fillScale"Inherited from: IgxGeographicShapeSeriesBaseComponent
fillScale: IgxBrushScaleComponent fillScaleUseGlobalValues
Section titled "fillScaleUseGlobalValues"Inherited from: IgxGeographicShapeSeriesBaseComponent
fillScaleUseGlobalValues: boolean isCustomShapeMarkerStyleAllowed
Section titled "isCustomShapeMarkerStyleAllowed"Inherited from: IgxGeographicShapeSeriesBaseComponent
isCustomShapeMarkerStyleAllowed: boolean isCustomShapeStyleAllowed
Section titled "isCustomShapeStyleAllowed"Inherited from: IgxGeographicShapeSeriesBaseComponent
isCustomShapeStyleAllowed: boolean itemSearchMode
Section titled "itemSearchMode"Inherited from: IgxGeographicShapeSeriesBaseComponent
itemSearchMode: ShapeItemSearchMode itemSearchPointsThreshold
Section titled "itemSearchPointsThreshold"Inherited from: IgxGeographicShapeSeriesBaseComponent
itemSearchPointsThreshold: number itemSearchThreshold
Section titled "itemSearchThreshold"Inherited from: IgxGeographicShapeSeriesBaseComponent
itemSearchThreshold: number shapeDataSource
Section titled "shapeDataSource"Inherited from: IgxGeographicShapeSeriesBaseComponent
shapeDataSource: string shapefileDataSource
Section titled "shapefileDataSource"Inherited from: IgxGeographicShapeSeriesBaseComponent
shapefileDataSource: IgxShapeDataSource shapeFill
Section titled "shapeFill"shapeFill: string shapeFilterResolution
Section titled "shapeFilterResolution"Inherited from: IgxGeographicShapeSeriesBaseComponent
shapeFilterResolution: number shapeMemberPath
Section titled "shapeMemberPath"Inherited from: IgxGeographicShapeSeriesBaseComponent
shapeMemberPath: string shapeOpacity
Section titled "shapeOpacity"shapeOpacity: number shapeStroke
Section titled "shapeStroke"shapeStroke: string shapeStrokeThickness
Section titled "shapeStrokeThickness"shapeStrokeThickness: number visibleFromScale
Section titled "visibleFromScale"Inherited from: IgxGeographicShapeSeriesBaseComponent
visibleFromScale: number 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>
hasMarkers
Section titled "hasMarkers"Inherited from: IgxGeographicShapeSeriesBaseComponent
Gets whether this series supports markers
get hasMarkers(): boolean Returns boolean
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
styleShape
Section titled "styleShape"get styleShape(): EventEmitter<object> Returns EventEmitter<object>
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