IgxGeographicProportionalSymbolSeriesComponent

Series class for a geographic map with points marked at given locations. This is the geographic equivalent of a ScatterSeries.

Constructors

IgxGeographicProportionalSymbolSeriesComponent

new IgxGeographicProportionalSymbolSeriesComponent(): IgxGeographicProportionalSymbolSeriesComponent

Returns IgxGeographicProportionalSymbolSeriesComponent

Properties

ngAcceptInputType_fillScaleUseGlobalValues

ngAcceptInputType_fillScaleUseGlobalValues: string | boolean

ngAcceptInputType_hasMarkers

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_hasMarkers: string | boolean

ngAcceptInputType_hasOnlyMarkers

ngAcceptInputType_hasOnlyMarkers: string | boolean

ngAcceptInputType_isCustomScatterMarkerStyleAllowed

ngAcceptInputType_isCustomScatterMarkerStyleAllowed: string | boolean

ngAcceptInputType_isCustomScatterStyleAllowed

ngAcceptInputType_isCustomScatterStyleAllowed: string | boolean

ngAcceptInputType_isGeographic

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_isGeographic: string | boolean

ngAcceptInputType_itemSearchMode

ngAcceptInputType_itemSearchMode: any

ngAcceptInputType_itemSearchThreshold

ngAcceptInputType_itemSearchThreshold: string | number

ngAcceptInputType_markerBrushBrightness

ngAcceptInputType_markerBrushBrightness: string | number

ngAcceptInputType_markerFillMode

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_markerFillMode: any

ngAcceptInputType_markerOutlineBrightness

ngAcceptInputType_markerOutlineBrightness: string | number

ngAcceptInputType_markerOutlineMode

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_markerOutlineMode: any

ngAcceptInputType_markerOutlineUsesFillScale

ngAcceptInputType_markerOutlineUsesFillScale: string | boolean

ngAcceptInputType_markerThickness

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_markerThickness: string | number

ngAcceptInputType_markerType

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_markerType: any

ngAcceptInputType_maximumMarkers

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_maximumMarkers: string | number

ngAcceptInputType_radiusScaleUseGlobalValues

ngAcceptInputType_radiusScaleUseGlobalValues: string | boolean

ngAcceptInputType_visibleFromScale

Inherited from: IgxGeographicMarkerSeriesComponent

ngAcceptInputType_visibleFromScale: string | number

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxGeographicProportionalSymbolSeriesComponent, "igx-geographic-proportional-symbol-series", never, object, object, never, never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxGeographicProportionalSymbolSeriesComponent, never>

Accessors

actualMarkerBrush

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

assigningScatterMarkerStyle

Event raised when Assigning Scatter Marker Style

get assigningScatterMarkerStyle(): EventEmitter<object>

Returns EventEmitter<object>

assigningScatterStyle

Event raised when Assigning Category Style

get assigningScatterStyle(): EventEmitter<object>

Returns EventEmitter<object>

coercionMethods

Inherited from: IgxGeographicMarkerSeriesComponent

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

fillMemberPath

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

Gets or sets the brush scale for the marker brush.

get fillScale(): IgxBrushScaleComponent

Returns IgxBrushScaleComponent

set fillScale(v: IgxBrushScaleComponent): void

Parameters

v: IgxBrushScaleComponent

Returns void

fillScaleUseGlobalValues

Gets or sets the whether or not the FillScale uses global values of FillMemberPath of 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

Inherited from: IgxGeographicMarkerSeriesComponent

Gets whether this series supports markers

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

isCustomScatterMarkerStyleAllowed

Gets or sets whether this Scatter series should allow custom style overrides of its individual marker visuals.

get isCustomScatterMarkerStyleAllowed(): boolean

Returns boolean

set isCustomScatterMarkerStyleAllowed(v: boolean): void

Parameters

v: boolean

Returns void

isCustomScatterStyleAllowed

Gets or sets whether this Scatter series should allow custom style overrides of its individual visuals.

get isCustomScatterStyleAllowed(): boolean

Returns boolean

set isCustomScatterStyleAllowed(v: boolean): void

Parameters

v: boolean

Returns void

isGeographic

Inherited from: IgxGeographicMarkerSeriesComponent

Checks if this control is geographic coordinate system

get isGeographic(): boolean

Returns boolean

itemSearchMode

Gets or sets the mode the series will use to find the closest point to the cursor.

get itemSearchMode(): ScatterItemSearchMode

Returns ScatterItemSearchMode

set itemSearchMode(v: ScatterItemSearchMode): void

Parameters

v: ScatterItemSearchMode

Returns void

itemSearchThreshold

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

labelMemberPath

Gets or sets the Label mapping property for the current series object.

get labelMemberPath(): string

Returns string

set labelMemberPath(v: string): void

Parameters

v: string

Returns void

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

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

markerBrush

Inherited from: IgxGeographicMarkerSeriesComponent

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

markerBrushBrightness

Gets or sets brightness of the marker fill. Using negative value will change marker fill to darker color and positive value will change marker fill to brighter color Note you can use any values between minimum value of -1 (darkest fill) and maximum value of 1 (brightest fill)

get markerBrushBrightness(): number

Returns number

set markerBrushBrightness(v: number): void

Parameters

v: number

Returns void

markerFillMode

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

markerOutlineBrightness

Gets or sets brightness of the marker outline. Using negative value will change marker outline to darker color and positive value will change marker outline to brighter color Note you can use any values between minimum value of -1 (darkest outline) and maximum value of 1 (brightest outline)

get markerOutlineBrightness(): number

Returns number

set markerOutlineBrightness(v: number): void

Parameters

v: number

Returns void

markerOutlineMode

Inherited from: IgxGeographicMarkerSeriesComponent

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

markerOutlineUsesFillScale

Gets or sets whether or not the marker outline should use FillScale like the marker fill does. This setting applies only if the current series has a FillScale set and it overrides MarkerOutline setting.

get markerOutlineUsesFillScale(): boolean

Returns boolean

set markerOutlineUsesFillScale(v: boolean): void

Parameters

v: boolean

Returns void

markerTemplate

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

Gets or sets thickness of the marker outline

get markerThickness(): number

Returns number

set markerThickness(v: number): void

Parameters

v: number

Returns void

markerType

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

radiusMemberPath

Gets or sets the radius mapping property for the current series object.

get radiusMemberPath(): string

Returns string

set radiusMemberPath(v: string): void

Parameters

v: string

Returns void

radiusScale

Gets or sets the radius size scale for the bubbles.

get radiusScale(): IgxSizeScaleComponent

Returns IgxSizeScaleComponent

set radiusScale(v: IgxSizeScaleComponent): void

Parameters

v: IgxSizeScaleComponent

Returns void

radiusScaleUseGlobalValues

Gets or sets the whether or not the RadiusScale uses global values of RadiusMemberPath of multiple series. This setting applies only if multiple series are using the same RadiusScale.

get radiusScaleUseGlobalValues(): boolean

Returns boolean

set radiusScaleUseGlobalValues(v: boolean): void

Parameters

v: boolean

Returns void

visibleFromScale

Inherited from: IgxGeographicMarkerSeriesComponent

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

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getItem

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

item: any
memberPathName: string

Returns any

getMemberPathValue

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgxGeographicMarkerSeriesComponent

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

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgxGeographicMarkerSeriesComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

notifyIndexedPropertiesChanged

Inherited from: IgxGeographicMarkerSeriesComponent

Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

notifyIndexedPropertiesChanged(): void

Returns void

renderSeries

Inherited from: IgxGeographicMarkerSeriesComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

animate: boolean
- True if the change should be animated.

Returns void

styleUpdated

Inherited from: IgxGeographicMarkerSeriesComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

register

register(): void