Series class for a geographic map with points marked at given locations. This is the geographic equivalent of a HighDensityScatterSeries.
Constructors
Section titled "Constructors"IgxGeographicHighDensityScatterSeriesComponent
new IgxGeographicHighDensityScatterSeriesComponent(): IgxGeographicHighDensityScatterSeriesComponent Returns IgxGeographicHighDensityScatterSeriesComponent
Properties
Section titled "Properties"ngAcceptInputType_hasMarkers
Section titled "ngAcceptInputType_hasMarkers"Inherited from: IgxGeographicMapSeriesHostComponent
ngAcceptInputType_hasMarkers: string | boolean ngAcceptInputType_heatMaximum
Section titled "ngAcceptInputType_heatMaximum"ngAcceptInputType_heatMaximum: string | number ngAcceptInputType_heatMinimum
Section titled "ngAcceptInputType_heatMinimum"ngAcceptInputType_heatMinimum: string | number ngAcceptInputType_isGeographic
Section titled "ngAcceptInputType_isGeographic"Inherited from: IgxGeographicMapSeriesHostComponent
ngAcceptInputType_isGeographic: string | boolean ngAcceptInputType_isPixel
Section titled "ngAcceptInputType_isPixel"ngAcceptInputType_isPixel: string | boolean ngAcceptInputType_mouseOverEnabled
Section titled "ngAcceptInputType_mouseOverEnabled"ngAcceptInputType_mouseOverEnabled: string | boolean ngAcceptInputType_pointExtent
Section titled "ngAcceptInputType_pointExtent"ngAcceptInputType_pointExtent: string | number ngAcceptInputType_progressiveLoad
Section titled "ngAcceptInputType_progressiveLoad"ngAcceptInputType_progressiveLoad: string | boolean ngAcceptInputType_progressiveStatus
Section titled "ngAcceptInputType_progressiveStatus"ngAcceptInputType_progressiveStatus: string | number ngAcceptInputType_useBruteForce
Section titled "ngAcceptInputType_useBruteForce"ngAcceptInputType_useBruteForce: string | boolean ngAcceptInputType_visibleFromScale
Section titled "ngAcceptInputType_visibleFromScale"Inherited from: IgxGeographicMapSeriesHostComponent
ngAcceptInputType_visibleFromScale: string | number ɵcmp: ɵɵComponentDeclaration<IgxGeographicHighDensityScatterSeriesComponent, "igx-geographic-high-density-scatter-series", never, object, object, never, never, true, never> ɵfac: ɵɵFactoryDeclaration<IgxGeographicHighDensityScatterSeriesComponent, never> Accessors
Section titled "Accessors"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
heatMaximum
Section titled "heatMaximum"Gets or sets the value that maps to the maximum heat color.
get heatMaximum(): number
Returns number
set heatMaximum(v: number): void Parameters
- v:
number
Returns void
heatMaximumColor
Section titled "heatMaximumColor"Gets or sets the color to use for the maximum end of the scale.
get heatMaximumColor(): string
Returns string
set heatMaximumColor(v: string): void Parameters
- v:
string
Returns void
heatMinimum
Section titled "heatMinimum"Gets or sets the density value that maps to the minimum heat color.
get heatMinimum(): number
Returns number
set heatMinimum(v: number): void Parameters
- v:
number
Returns void
heatMinimumColor
Section titled "heatMinimumColor"Gets or sets the color to use for the minimum end of the scale.
get heatMinimumColor(): string
Returns string
set heatMinimumColor(v: string): void Parameters
- v:
string
Returns void
isGeographic
Section titled "isGeographic"Inherited from: IgxGeographicMapSeriesHostComponent
Checks if this control is geographic coordinate system
get isGeographic(): boolean
Returns boolean
isPixel
Section titled "isPixel"Gets whether the current series shows pixels.
get isPixel(): boolean
Returns boolean
latitudeMemberPath
Section titled "latitudeMemberPath"The name of the property of ItemsSource items which contains the latitude coordinate of the symbol.
get latitudeMemberPath(): string
Returns string
set latitudeMemberPath(v: string): void Parameters
- v:
string
Returns void
longitudeMemberPath
Section titled "longitudeMemberPath"The name of the property of ItemsSource items which contains the longitude coordinate of the symbol.
get longitudeMemberPath(): string
Returns string
set longitudeMemberPath(v: string): void Parameters
- v:
string
Returns void
mouseOverEnabled
Section titled "mouseOverEnabled"Gets or sets the whether the chart reacts to mouse move events.
get mouseOverEnabled(): boolean
Returns boolean
set mouseOverEnabled(v: boolean): void Parameters
- v:
boolean
Returns void
pointExtent
Section titled "pointExtent"Gets or sets the the pixel extent of the square data points that are rendered.
get pointExtent(): number
Returns number
set pointExtent(v: number): void Parameters
- v:
number
Returns void
progressiveLoad
Section titled "progressiveLoad"Gets or sets the whether to progressively load the data into the chart.
get progressiveLoad(): boolean
Returns boolean
set progressiveLoad(v: boolean): void Parameters
- v:
boolean
Returns void
progressiveLoadStatusChanged
Section titled "progressiveLoadStatusChanged"Raised when the progressive loading state of the series has changed.
get progressiveLoadStatusChanged(): EventEmitter<object>
Returns EventEmitter<object>
progressiveStatus
Section titled "progressiveStatus"Represents the current status of the progressive load of the series. It will range from 0 to 100, where 100 is fully loaded.
get progressiveStatus(): number
Returns number
set progressiveStatus(v: number): void Parameters
- v:
number
Returns void
useBruteForce
Section titled "useBruteForce"Gets or sets the whether to use use brute force mode.
get useBruteForce(): boolean
Returns boolean
set useBruteForce(v: boolean): void Parameters
- v:
boolean
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
register
Section titled "register"register(): void