Class IgrGeographicPolylineSeries<SS>

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

Type parameters

  • SS

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

actualAreaFillOpacity

actualAreaFillOpacity: number

Gets the actual opacity applied to the area fill visual.

let actualFillOpacity: number = series.actualAreaFillOpacity;

actualBrush

actualBrush: string

Gets the effective brush for the current series object.

let actualBrush: string = series.actualBrush;

actualHitTestMode

actualHitTestMode: SeriesHitTestMode

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

let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;

actualOutline

actualOutline: string

Gets the effective outline for the current series object.

let actualOutline: string = series.ActualOutline;

areaFillOpacity

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

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

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>

dataSource

dataSource: any

discreteLegendItemTemplate

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

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

finalValue: number

The final value of this series.

hasMarkers

hasMarkers: boolean

Returns whether the current series supports visual markers.

let hasMarkers: boolean = this.series.hasMarkers;

hitTestMode

hitTestMode: 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;

isAnnotationLayer

isAnnotationLayer: boolean

Gets whether the series is an annotation layer.

let isAnnotationLayer: boolean = this.series.isAnnotationLayer;

isAreaOrLine

isAreaOrLine: boolean

Gets whether the current series shows an area or line shape.

let isAreaorLine: boolean = this.series.isAreaorLine;

isCategory

isCategory: boolean

Gets whether the current series is a category type series.

let isCategory: boolean = this.series.isCategory;

isDefaultCrosshairBehaviorDisabled

isDefaultCrosshairBehaviorDisabled: boolean

Gets whether the default crosshair behavior should be disabled if this series is present.

isDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

let isDefaultCrosshairBehaviorDisabled: boolean = this.series.isDefaultCrosshairBehaviorDisabled;

isDefaultToolTipSelected

isDefaultToolTipSelected: 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;

isDefaultTooltipBehaviorDisabled

isDefaultTooltipBehaviorDisabled: boolean

Gets whether the default tooltip behavior should be disabled if this series is present.

 let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;

isDropShadowEnabled

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

isFinancial

isFinancial: boolean

Gets whether the current series is a financial type series.

let isFinancial: boolean = this.series.isFinancial;

isFragment

isFragment: boolean

Gets whether the current series is a stack fragment.

let isFragment: boolean = this.series.isFragment;

isHighlightingEnabled

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

isIndexed

isIndexed: boolean

Gets if the series uses an index, which can be used to auto-assign it a color.

let isIndexed: boolean = this.series.isIndexed;

isMarkerlessDisplayPreferred

isMarkerlessDisplayPreferred: boolean

Overridden by derived series classes to indicate when markerless display is preferred or not.

isNegativeColorSupported

isNegativeColorSupported: boolean

Overridden by derived series classes to indicate when negative colors are supported or not.

isPolar

isPolar: boolean

Gets whether the current series is a polar type series.

let isPolar: boolean = this.series.isPolar;

isRadial

isRadial: boolean

Gets whether the current series is a radial type series.

let isRadial: boolean = this.series.isRadial;

isRange

isRange: boolean

Gets whether the current series is a range type series.

let isRange: boolean = this.series.isRange;

isScatter

isScatter: boolean

Gets whether the current series is a scatter type series.

let isScatter: boolean = this.series.isScatter;

isShape

isShape: boolean

Gets whether the current series is a shape type series.

isStacked

isStacked: boolean

Gets whether the current series is a stacked type series.

let isStacked: boolean = this.series.isStacked;

isUsableInLegend

isUsableInLegend: boolean

Gets if the series should appear in any legends.

let isUsableInLegend: boolean = this.series.isUsableInLegend;

isValueOverlay

isValueOverlay: boolean

Gets whether the series is a value overlay.

isVertical

isVertical: boolean

Gets whether the current series is oriented vertically.

let isVertical: boolean = this.series.isVertical;

legendItemBadgeTemplate

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

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

legendItemVisibility: Visibility

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

The LegendItemVisibilty can be used to exclude only certain IgrSeries from the IgrLegend.

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

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

    <IgrAreaSeries
     name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value"
    legendItemVisibility= "collapsed" />
 </IgrDataChart>

mouseOverEnabled

mouseOverEnabled: boolean

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

outline

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

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>

percentChange

percentChange: number

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

renderRequested

renderRequested: function

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>

Type declaration

    • (s: IgrSeries, e: IgrRenderRequestedEventArgs): void
    • Parameters

      • s: IgrSeries
      • e: IgrRenderRequestedEventArgs

      Returns void

resolution

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

seriesInternal

seriesInternal: any

shadowBlur

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

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

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

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

showDefaultTooltip

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

thickness: number

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

Depending on the IgrSeries type, this can be the main brush used, or just the outline. For example, when using a IgrLineSeries it will affect the thickness of the lines drawn, whereas when using a IgrColumnSeries 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

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 IgrSeries 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>

tooltipContainerTemplate

tooltipContainerTemplate: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

tooltipTemplate

tooltipTemplate: React.SFC<IChartTooltipProps> | Component<IChartTooltipProps>

transitionDuration

transitionDuration: 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 IgrSeries. 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

transitionEasingFunction: function

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 IgrSeries. 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;

Type declaration

    • (time: number): number
    • Parameters

      • time: number

      Returns number

transitionInDuration

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

transitionInEasingFunction: function

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;

Type declaration

    • (time: number): number
    • Parameters

      • time: number

      Returns number

transitionInSpeedType

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

useSingleShadow

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

Accessors

coercionMethods

  • get coercionMethods(): any
  • set coercionMethods(v: any): void
  • 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.

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

    Parameters

    • v: any

    Returns void

databaseSource

  • get databaseSource(): string
  • set databaseSource(value: string): void
  • Gets or sets the string path of the .dbf portion of the Shapefile.

    Returns string

  • Gets or sets the string path of the .dbf portion of the Shapefile.

    Parameters

    • value: string

    Returns void

isGeographic

  • get isGeographic(): boolean
  • Checks if this control is geographic coordinate system

    Returns boolean

shapeDataSource

  • get shapeDataSource(): string
  • set shapeDataSource(value: string): void
  • Gets or sets the string path of the .shp portion of the Shapefile.

    Returns string

  • Gets or sets the string path of the .shp portion of the Shapefile.

    Parameters

    • value: string

    Returns void

shapeFill

  • get shapeFill(): string
  • set shapeFill(v: string): void
  • Gets or sets the fill brush.

    Returns string

  • Gets or sets the fill brush.

    Parameters

    • v: string

    Returns void

shapeFilterResolution

  • get shapeFilterResolution(): number
  • set shapeFilterResolution(v: number): void
  • The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. In the case of GeographicPolylineSeries, the resolution is compared to either dimension, rather than both. In other words, a polyline will not be filtered if its height or its width exceeds the value of this property. Whereas with a ShapeSeries, both the height and the width must exceed the value of this property.

    Returns number

  • The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. In the case of GeographicPolylineSeries, the resolution is compared to either dimension, rather than both. In other words, a polyline will not be filtered if its height or its width exceeds the value of this property. Whereas with a ShapeSeries, both the height and the width must exceed the value of this property.

    Parameters

    • v: number

    Returns void

shapeMemberPath

  • get shapeMemberPath(): string
  • set shapeMemberPath(v: string): void
  • The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points.

    Returns string

  • The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points.

    Parameters

    • v: string

    Returns void

shapeOpacity

  • get shapeOpacity(): number
  • set shapeOpacity(v: number): void
  • Gets or sets the opacity.

    Returns number

  • Gets or sets the opacity.

    Parameters

    • v: number

    Returns void

shapeStroke

  • get shapeStroke(): string
  • set shapeStroke(v: string): void
  • Gets or sets the stroke brush.

    Returns string

  • Gets or sets the stroke brush.

    Parameters

    • v: string

    Returns void

shapeStrokeThickness

  • get shapeStrokeThickness(): number
  • set shapeStrokeThickness(v: number): void
  • Gets or sets the stroke thickness.

    Returns number

  • Gets or sets the stroke thickness.

    Parameters

    • v: number

    Returns void

shapefileDataSource

  • get shapefileDataSource(): IgrShapeDataSource
  • set shapefileDataSource(v: IgrShapeDataSource): void

styleShape

  • get styleShape(): function
  • set styleShape(ev: function): void

visibleFromScale

  • get visibleFromScale(): number
  • set visibleFromScale(v: number): void
  • 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%.

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

    Parameters

    • v: number

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

bindAxes

  • bindAxes(axes: IgrAxis[]): void
  • Parameters

    • axes: IgrAxis[]

    Returns void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

ensureShapeStyle

  • ensureShapeStyle(): void
  • Returns void

fromWorldPosition

  • fromWorldPosition(world: IgPoint): IgPoint
  • Converts a point from world coordinates to coordinates within the viewport of the series.

    Parameters

    • world: IgPoint
      • The world position from which to convert.

    Returns IgPoint

getEffectiveViewport

  • getEffectiveViewport(): IgRect
  • Gets the effective viewport, adjusted to account for margins and other factors.

    Returns IgRect

getExactItemIndex

  • getExactItemIndex(world: IgPoint): number
  • Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

    Parameters

    • world: IgPoint
      • The world position for which to return the index.
      let index: number = this.series.getExactItemIndex({x:.5,y:.5});

    Returns number

getItem

  • getItem(world: IgPoint): any
  • Gets the item that is the best match for the specified world coordinates.

    Parameters

    • world: IgPoint
      • The world coordinates to use.

    Returns any

getItemIndex

  • getItemIndex(world: IgPoint): number
  • Gets the item item index associated with the specified world position

    let index: number = this.series.getItemIndex({x:.5,y:.5});

    Parameters

    • world: IgPoint

    Returns number

getItemSpan

  • getItemSpan(): number
  • 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.

    let span: number = this.series.getItemSpan();

    Returns number

getItemValue

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

    • item: any
    • memberPathName: string

    Returns any

getNextOrExactIndex

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

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

getPreviousOrExactIndex

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

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

getSeriesHighValue

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

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

    Returns number

getSeriesHighValuePosition

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

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

    Returns IgPoint

getSeriesLowValue

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

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

    Returns number

getSeriesLowValuePosition

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

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

    Returns IgPoint

getSeriesValue

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

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

    Returns number

getSeriesValueBoundingBox

  • getSeriesValueBoundingBox(world: IgPoint): IgRect
  • If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

    Parameters

    • world: IgPoint
      • The world coordinate for which to get a value bounding box for

    Returns IgRect

getSeriesValueFromSeriesPixel

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

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

    Returns number

getSeriesValueMarkerBoundingBox

  • getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect
  • 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.

    Parameters

    • world: IgPoint
      • The world coordinates for which to get a value marker bounding box for

    Returns IgRect

getSeriesValuePosition

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

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

    Returns IgPoint

getSeriesValuePositionFromSeriesPixel

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

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

    Returns IgPoint

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

hideToolTips

  • hideToolTips(): void
  • Hides any internal tooltips presented by the series, if any.

    Returns void

moveCursorPoint

  • moveCursorPoint(point: IgPoint): void
  • Moves the cursor point to the provided world position. Some series may react to the current cursor position.

    Parameters

    • point: IgPoint
      • The cursor point, in world coordinates.

      moveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.

      this.crosshair.moveCursorPoint({x:.5,y:.5});

    Returns void

provideData

  • provideData(data: any[]): void
  • Parameters

    • data: any[]

    Returns void

removeAllAlternateViews

  • removeAllAlternateViews(): void
  • Removes all alternate views of this series.

    Returns void

removeAlternateView

  • removeAlternateView(viewIdentifier: string): void
  • Removes an alternate view of this series.

    Parameters

    • viewIdentifier: string
      • The string identifier for the view to remove.

    Returns void

removeAxes

  • removeAxes(): void
  • Call to null out the axes of the series;

    Returns void

render

  • render(): any
  • Returns any

renderSeries

  • renderSeries(animate: boolean): void
  • Renders the series.

    Parameters

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

    Returns void

replayTransitionIn

  • replayTransitionIn(): void
  • Replays the assigned transition in animation, if any.

    this.series.replayTransitionIn();

    Returns void

resolveTooltipBrush

  • resolveTooltipBrush(): string
  • Gets the brush for tooltip labels.

    Returns string

scrollIntoView

  • scrollIntoView(item: any): boolean
  • Requests that the provided item should be brought into view if possible.

    Parameters

    • item: any
      • The item to attempt to bring into view.
      this.series.scrollIntoView(dataItem);

    Returns boolean

setNegativeColors

  • setNegativeColors(negativeBrush: string, negativeOutline: string): void
  • Parameters

    • negativeBrush: string
    • negativeOutline: string

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

simulateHover

  • simulateHover(point: IgPoint): void
  • Simulates a pointer hover over the series surface.

    Parameters

    • point: IgPoint
      • The pointer position relative to the series viewport over which to hover.

      When tooltips are enabled, simulateHover can be used to automatically display the tooltip over a particular series item.

      this.series.simulateHover({x:250,y:250});

    Returns void

styleUpdated

  • styleUpdated(): void
  • Called when this series' Style is updated.

    Returns void

toWorldPosition

  • toWorldPosition(seriesPoint: IgPoint): IgPoint
  • Converts a point from coordinates within the series plot area to a world position within axis space.

    Parameters

    • seriesPoint: IgPoint
      • The pixel location within the plot area of the series.
      this.series.toWorldPosition({x:500,y:500});

    Returns IgPoint

Static _createFromInternal

  • _createFromInternal(internal: any): IgrSeries
  • Parameters

    • internal: any

    Returns IgrSeries