Interface IIgrGeographicHighDensityScatterSeriesProps

Hierarchy

Hierarchy

Properties

Properties

actualAreaFillOpacity?: string | number

Gets the actual opacity applied to the area fill visual.

let actualFillOpacity: number = series.actualAreaFillOpacity;
actualBrush?: string

Gets the effective brush for the current series object.

let actualBrush: string = series.actualBrush;
actualHighlightedValuesFadeOpacity?: string | number

Gets actual HighlightedValues fade opacity

actualHighlightingFadeOpacity?: string | number

Gets actual highlighting fade opacity

actualHighlightingMode?: string | SeriesHighlightingMode

Gets actual highlighting mode

actualHitTestMode?: string | SeriesHitTestMode

Resolved method of hit testing to use when pointing to items in the chart.

let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;
actualLegendItemBadgeBrush?: string

Gets the effective legend badge fill for the current series.

actualLegendItemBadgeOutline?: string

Gets the effective legend badge outline for the current series.

actualLegendItemBadgeTemplate?: IgDataTemplate

Gets the actual legend item badge template used by the series.

actualMarkerFillOpacity?: string | number

Gets the actual opacity applied to the fill of the markers.

actualOutline?: string

Gets the effective outline for the current series object.

let actualOutline: string = series.ActualOutline;
actualResolution?: string | number
actualThickness?: string | number

Gets the effective Thickness for the current series object.

areaFillOpacity?: string | number

Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
actualAreaFillOpacity= {1} />
</IgrDataChart>
brush?: string

Gets or sets the brush to use for the series.

The Brush along with the Outline and Negative Brush can be used to affect the visuals of the Series.

this.series.brush = "red";
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
brush="Gray"
outline="Black" />
</IgrDataChart>
children?: ReactNode
coercionMethods?: any

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.

dashArray?: string | number[]

Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

dataSource?: any
discreteLegendItemTemplate?: IgDataTemplate

Gets or sets the DiscreteLegendItemTemplate property. The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

expectFunctions?: string | boolean

Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

expectFunctions is used to decide whether the series should expect that its data source members need to be called as functions to get their values.

 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="MyFunction"
expectFunctions={true} />
</IgrDataChart>
this.series.expectFunctions=true;
finalValue?: string | number

The final value of this series.

heatMaximum?: string | number

Gets or sets the value that maps to the maximum heat color.

heatMaximumColor?: string

Gets or sets the color to use for the maximum end of the scale.

heatMinimum?: string | number

Gets or sets the density value that maps to the minimum heat color.

heatMinimumColor?: string

Gets or sets the color to use for the minimum end of the scale.

highlightedDataSource?: any
highlightedTitleSuffix?: string

Gets or sets the HighlightedTitleSuffix property.

highlightedValuesDisplayMode?: string | SeriesHighlightedValuesDisplayMode

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

highlightedValuesFadeOpacity?: string | number

Gets or sets the target opacity to fade to for fade style HighlightedValues.

highlightingFadeOpacity?: string | number

Gets or sets the target opacity to fade to for fade style highlighting.

hitTestMode?: string | SeriesHitTestMode

Method of hit testing to use when pointing to items in this series.

The HitTestMode can be set to either:

  • Auto: automatically decide the appropriate hit test mode for the series.
  • ColorEncoded: use a color encoded off screen buffer for hit testing. Should always be O(1) time for determining a hit series. This increases frame render time and memory usage, however. Consider using this if hit testing time is degrading performance.
  • Computational: use a computational based approach to determine whether the series has been hit. This uses loose bounding boxes, in some cases, and can range in time complexity between O(1) and O(log n) to find a hit. This decreases frame render time compared to color encoded
this.series.hitTestMode = SeriesHitTestMode.Computational;
isActualLegendFinancial?: string | boolean

Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

isComponentHighlightingModeIgnored?: string | boolean

Gets or sets whether the component level highlight mode is ignored.

isDefaultToolTipSelected?: string | boolean

Gets if the default tooltip has been selected for display.

To use the default tooltip set ShowDefaultTooltip to true.

let isDefaultToolTipSelected: boolean = this.series.isDefaultToolTipSelected;
isDropShadowEnabled?: string | boolean

Gets or sets whether drop shadow should be enabled for this series.

IsDropShadowEnabled is used to decide whether drop shadow should be enabled for this series.

this.series.isDropShadowEnabled = true;
<IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isDropShadowEnabled="true" />
</IgrDataChart>
isHighlightingEnabled?: string | boolean

Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

this.series.isHighlightingEnabled = true;
<IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isHighlightingEnabled="true" />
</IgrDataChart>
latitudeMemberPath?: string

The name of the property of ItemsSource items which contains the latitude coordinate of the symbol.

legend?: any

Gets or sets the legend used for the current series.

legendItemBadgeMode?: string | LegendItemBadgeMode

Gets or sets the mode of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

legendItemBadgeShape?: string | LegendItemBadgeShape

Gets or sets the type of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

legendItemBadgeTemplate?: IgDataTemplate

Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

legendItemTemplate?: IgDataTemplate

Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

legendItemVisibility?: string | Visibility

Gets or sets the legend item visibility for the current series object.

The LegendItemVisibilty can be used to exclude only certain Series from the Legend.

 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
legendItemVisibility= "collapsed" />
</IgrDataChart>
lineCap?: string | PenLineCap

Gets or sets the style of the starting point of any lines or polylines representing this series. Not every series type has a line at which it would be appropriate to display a start cap, so this property does not affect every series type. LineSeries, for example, is affected by StartCap, but ColumnSeries is not.

lineJoin?: string | PenLineJoin

Gets or sets the brush that specifies current series object's line join style.

longitudeMemberPath?: string

The name of the property of ItemsSource items which contains the longitude coordinate of the symbol.

markerFillOpacity?: string | number

Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

mouseOverEnabled?: string | boolean

Gets or sets the whether the chart reacts to mouse move events.

name: string

Sets or gets a required unique name for the series.

opacity?: string | number
outline?: string

Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

The Outline along with the Brush and NegativeBrush can be used to affect the visuals of the Series.

this.series.brush = "red";
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
brush="Gray"
outline="Black" />
</IgrDataChart>
outlineMode?: string | SeriesOutlineMode

Gets or sets the outline mode to use for the series.

percentChange?: string | number

The percent change from the beginning to the end of this series.

pointExtent?: string | number

Gets or sets the the pixel extent of the square data points that are rendered.

progressiveLoad?: string | boolean

Gets or sets the whether to progressively load the data into the chart.

progressiveLoadStatusChanged?: ((s, e) => void)

Type declaration

progressiveStatus?: string | number

Represents the current status of the progressive load of the series. It will range from 0 to 100, where 100 is fully loaded.

renderRequested?: ((s, e) => void)

Type declaration

    • (s, e): void
    • This event is raised every time a render has been requested from a series.

       const series1 = new IgrAreaSeries({ name: "series1" });
      series1.valueMemberPath = "USA";
      series1.title = "USA";
      series1.xAxisName = "xAxis";
      series1.yAxisName = "yAxis";
      series1.renderRequested= this.onRenderRequested;

      public onRenderRequested =( s:IgrSeries, e: RenderRequestedEventArgs) => {
      }
       <IgrDataChart
      dataSource={this.state.dataSource} >

      <IgrNumericXAxis name="xAxis" />
      <IgrNumericYAxis name="yAxis" />

      <IgrAreaSeries
      name="series1"
      xAxisName="xAxis"
      yAxisName="yAxis"
      valueMemberPath="Value"
      shadowBlur="7"
      shadowColor="blue"
      renderRequested= {this.onRenderRequested}/>
      </IgrDataChart>

      Parameters

      • s: IgrSeries<IIgrSeriesProps>
      • e: IgrRenderRequestedEventArgs

      Returns void

resolution?: string | number

Gets or sets the current series object's rendering resolution.

Setting the Resolution on a Series to a higher value can help with performance, but it will lower the graphical fidelity of the line. As such, it can be increased up until the fidelity is unacceptable.

this.series.resolution = 1.5;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
resolution= {1.5} />
</IgrDataChart>
safeActualBrush?: string

Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

shadowBlur?: string | number

Gets or sets the shadow blur. This property is ignored when Series.UseSingleShadow is set to true.

ShadowBlur can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

this.series.shadowBlur = 7;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
shadowBlur={7}
shadowColor="blue" />
</IgrDataChart>
shadowColor?: string

Gets or sets the drop shadow color.

ShadowColor can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

this.series.shadowColor = "blue";
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
shadowBlur="7"
shadowColor="blue" />
</IgrDataChart>
shadowOffsetX?: string | number

Gets or sets the drop shadow x-offset.

ShadowOffsetX can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

this.series.shadowOffsetX = 10;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
shadowOffsetX= {10}
shadowOffsetY={10] />
</IgrDataChart>
shadowOffsetY?: string | number

Gets or sets the drop shadow y-offset.

ShadowOffsetY can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

this.series.shadowOffsetY = 10;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
shadowOffsetX= {10}
shadowOffsetY= {10} />
</IgrDataChart>
shouldAnimateOnDataSourceSwap?: string | boolean

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

shouldHideAutoCallouts?: string | boolean

Gets or sets whether this series should suppress it's auto callouts

shouldShiftOpacityForSafeActualBrush?: string | boolean

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

showDefaultTooltip?: string | boolean

Gets or sets whether default tooltip will be shown.

The default tooltips display all the information relevant to the particular series item (series title, data values, axis values etc.) and are styled to match the series' style. When using default tooltips, you should also set the series Title.

 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
showDefaultTooltip ="true"
title="InStock Items" />
</IgrDataChart>
this.series.showDefaultTooltip ="true";
thickness?: string | number

Gets or sets the width of the current series object's line thickness.

Depending on the Series type, this can be the main brush used, or just the outline. For example, when using a LineSeries it will affect the thickness of the lines drawn, whereas when using a ColumnSeries it will affect the outer border thickness of the columns.

this.series.thickness=5;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
thickness= {5} />
</IgrDataChart>
title?: any

Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

The Series Title may be used in tooltips and legends.

this.series.title = "InStock Items";
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
title="InStock Items" />
</IgrDataChart>
tooltipTemplate?: FunctionComponent<IChartTooltipProps> | Component<IChartTooltipProps, {}, any>
transitionDuration?: string | number

Gets or sets the duration of the current series's morph.

The TransitionDuration can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

this.series.transitionDuration = 500;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isTransitionInEnabled=true
transitionInSpeedType="indexScaled"
transitionDuration= {500}
transitionInDuration = {500} />
</IgrDataChart>
transitionEasingFunction?: ((time) => number)

Type declaration

    • (time): number
    • Gets or sets the easing function used to morph the current series.

      The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

       <IgrDataChart
      dataSource={this.state.dataSource} >

      <IgrNumericXAxis name="xAxis" />
      <IgrNumericYAxis name="yAxis" />

      <IgrAreaSeries
      name="series1"
      xAxisName="xAxis"
      yAxisName="yAxis"
      valueMemberPath="Value"
      isDropShadowEnabled=true
      markerType="circle"
      transitionEasingFunction ="cubicEase"
      isTransitionInEnabled= {true} />
      </IgrDataChart>
      this.series.transitionEasingFunction =  EasingFunctions.cubicEase;
      

      Parameters

      • time: number

      Returns number

transitionInDuration?: string | number

Gets or sets the duration of the current series's transition in morph.

The TransitionInDuration can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

this.series.transitionDuration = 500;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isTransitionInEnabled= {true}
transitionInSpeedType="indexScaled"
transitionDuration={500}
transitionInDuration= {500} />
</IgrDataChart>
transitionInEasingFunction?: ((time) => number)

Type declaration

    • (time): number
    • Gets or sets the EasingFunction used to morph the current series during the initial transition.

      The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

       <IgrDataChart
      dataSource={this.state.dataSource} >

      <IgrNumericXAxis name="xAxis" />
      <IgrNumericYAxis name="yAxis" />

      <IgrAreaSeries
      name="series1"
      xAxisName="xAxis"
      yAxisName="yAxis"
      valueMemberPath="Value"
      isDropShadowEnabled=true
      markerType="circle"
      transitionInEasingFunction ="cubicEase"
      isTransitionInEnabled= {true} />
      </IgrDataChart>
      this.series.transitionInEasingFunction =  EasingFunctions.cubicEase;
      

      Parameters

      • time: number

      Returns number

transitionInSpeedType?: string | TransitionInSpeedType

Gets or sets the duration of the current series's transition in morph.

The TransitionInSpeedType can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

this.series.transitionInSpeedType = TransitionInSpeedType.IndexScaled;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isTransitionInEnabled=true
transitionInSpeedType="indexScaled"
transitionDuration=500
transitionInDuration=500 />
</IgrDataChart>
transitionOutDuration?: string | number

Gets or sets the duration of the current series's transition out morph.

transitionOutEasingFunction?: ((time) => number)

Type declaration

    • (time): number
    • Gets or sets the EasingFunction used to morph the current series during the initial transition.

      Parameters

      • time: number

      Returns number

transitionOutSpeedType?: string | TransitionOutSpeedType

Gets or sets the duration of the current series's transition out morph.

useBruteForce?: string | boolean

Gets or sets the whether to use use brute force mode.

useSingleShadow?: string | boolean

Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. When this property is set to true, no Series.ShadowBlur is applied.

this.series.useSingleShadow = true;
 <IgrDataChart
dataSource={this.state.dataSource} >

<IgrNumericXAxis name="xAxis" />
<IgrNumericYAxis name="yAxis" />

<IgrAreaSeries
name="series1"
xAxisName="xAxis"
yAxisName="yAxis"
valueMemberPath="Value"
isDropShadowEnabled=true
markerType="circle"
useSingleShadow= {true} />
</IgrDataChart>
visibility?: string | Visibility
visibleFromScale?: string | number

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%.

visibleRangeMarginBottom?: string | number

Gets or sets the bottom margin to use when getting a visible axis range for the series.

visibleRangeMarginLeft?: string | number

Gets or sets the left margin to use when getting a visible axis range for the series.

visibleRangeMarginRight?: string | number

Gets or sets the right margin to use when getting a visible axis range for the series.

visibleRangeMarginTop?: string | number

Gets or sets the top margin to use when getting a visible axis range for the series.

visibleRangeMode?: string | SeriesVisibleRangeMode

Gets or sets the visible range mode to use.