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

Constructors

Section titled "Constructors"

IgcGeographicPolylineSeriesComponent

new IgcGeographicPolylineSeriesComponent(): IgcGeographicPolylineSeriesComponent

Returns IgcGeographicPolylineSeriesComponent

Properties

Section titled "Properties"

htmlTagName

Section titled "htmlTagName" 
htmlTagName: string

assigningShapeMarkerStyle

Section titled "assigningShapeMarkerStyle"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

assigningShapeMarkerStyle: object

assigningShapeStyle

Section titled "assigningShapeStyle"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

assigningShapeStyle: object

coercionMethods

Section titled "coercionMethods"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

coercionMethods: any

databaseSource

Section titled "databaseSource"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

databaseSource: string

fillMemberPath

Section titled "fillMemberPath"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

fillMemberPath: string

fillScale

Section titled "fillScale"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

fillScale: IgcBrushScaleComponent

fillScaleUseGlobalValues

Section titled "fillScaleUseGlobalValues"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

fillScaleUseGlobalValues: boolean

isCustomShapeMarkerStyleAllowed

Section titled "isCustomShapeMarkerStyleAllowed"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

isCustomShapeMarkerStyleAllowed: boolean

isCustomShapeStyleAllowed

Section titled "isCustomShapeStyleAllowed"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

isCustomShapeStyleAllowed: boolean

itemSearchMode

Section titled "itemSearchMode"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

itemSearchMode: ShapeItemSearchMode

itemSearchPointsThreshold

Section titled "itemSearchPointsThreshold"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

itemSearchPointsThreshold: number

itemSearchThreshold

Section titled "itemSearchThreshold"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

itemSearchThreshold: number

shapeDataSource

Section titled "shapeDataSource"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

shapeDataSource: string

shapefileDataSource

Section titled "shapefileDataSource"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

shapefileDataSource: IgcShapeDataSource

shapeFill

Section titled "shapeFill" 
shapeFill: string

shapeFilterResolution

Section titled "shapeFilterResolution"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

shapeFilterResolution: number

shapeMemberPath

Section titled "shapeMemberPath"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

shapeMemberPath: string

shapeOpacity

Section titled "shapeOpacity" 
shapeOpacity: number

shapeStroke

Section titled "shapeStroke" 
shapeStroke: string

shapeStrokeThickness

Section titled "shapeStrokeThickness" 
shapeStrokeThickness: number

styleShape

Section titled "styleShape" 
styleShape: object

visibleFromScale

Section titled "visibleFromScale"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

visibleFromScale: number

Accessors

Section titled "Accessors"

hasMarkers

Section titled "hasMarkers"

Inherited from: IgcGeographicShapeSeriesBaseComponent

Gets whether this series supports markers

get hasMarkers(): boolean

Returns boolean

isGeographic

Section titled "isGeographic"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

observedAttributes

Section titled "observedAttributes" 
get observedAttributes(): string[]

Returns string[]

Methods

Section titled "Methods"

connectedCallback

Section titled "connectedCallback" 
connectedCallback(): void

Returns void

disconnectedCallback

Section titled "disconnectedCallback" 
disconnectedCallback(): void

Returns void

ensureShapeStyle

Section titled "ensureShapeStyle" 
ensureShapeStyle(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

findByName(name: string): any

Parameters

  • name: string

Returns any

getItem

Section titled "getItem"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

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

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

Parameters

  • item: any
  • memberPathName: string

Returns any

getMemberPathValue

Section titled "getMemberPathValue"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Section titled "getPreviousOrExactIndex"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

getSeriesHighValue

Section titled "getSeriesHighValue"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesHighValuePosition

Section titled "getSeriesHighValuePosition"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

getSeriesLowValue

Section titled "getSeriesLowValue"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesLowValuePosition

Section titled "getSeriesLowValuePosition"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

getSeriesValue

Section titled "getSeriesValue"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns number

getSeriesValueBoundingBox

Section titled "getSeriesValueBoundingBox"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

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

Parameters

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

Returns number

getSeriesValueMarkerBoundingBox

Section titled "getSeriesValueMarkerBoundingBox"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

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

Parameters

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

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Section titled "getSeriesValuePositionFromSeriesPixel"

Inherited from: IgcGeographicShapeSeriesBaseComponent 

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

Parameters

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

Returns IgPoint

notifyIndexedPropertiesChanged

Section titled "notifyIndexedPropertiesChanged"

Inherited from: IgcGeographicShapeSeriesBaseComponent

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

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

Called when this series' Style is updated.

styleUpdated(): void

Returns void

register

Section titled "register" 
register(): void

Returns void