Interface IIgrNumericYAxisProps

Hierarchy

Properties

Optional abbreviateLargeNumbers

abbreviateLargeNumbers: boolean | string

A boolean indicating whether or not to abbreviate large numbers.

Optional actualInterval

actualInterval: number | string

Gets the effective value for the current Interval.

let effectiveInterval: number = yAxis.actualInterval;

Optional actualIsLogarithmic

actualIsLogarithmic: boolean | string

Determines if the axis has a valid logarithmic scale.

let effectiveLogarithmic: boolean = this.yAxis.actualIsLogarithmic

Optional actualMajorStroke

actualMajorStroke: string

Gets or sets the ActualMajorStroke property.

The actualMajorStroke property is used for ActualMajorStroke of the axis.

Optional actualMaximumValue

actualMaximumValue: number | string

Gets the effective maximum value for the current numeric axis object.

let effectiveMaxValue: number = yAxis.actualMaximumValue;

Optional actualMinimumValue

actualMinimumValue: number | string

Gets the effective minimum value for the current numeric axis object.

let effectiveMinValue: number = yAxis.actualMinimumValue;

Optional actualMinorInterval

actualMinorInterval: number | string

Gets the effective value for the current MinorInterval.

let effectiveMinorInterval: number = yAxis.actualMinorInterval;

Optional actualMinorStroke

actualMinorStroke: string

Gets or sets the ActualMinorStroke property.

The actualMinorStroke property is used for ActualMinorStroke of the axis.

Optional actualStroke

actualStroke: string

Gets or sets the effective stroke used for the axis.

Optional actualVisibleMaximumValue

actualVisibleMaximumValue: number | string

Gets the effective visible maximum value for the current numeric axis object.

The actualVisibleMaximumValue is used to get the current visible maximum value for the a numeric axis. Note, at times the actualVisibleMaximumValue may differ from the actualMaximumValue, for example when the chart is zoomed.

let effectiveVisibleMaxValue: number = yAxis.actualVisibleMaximumValue;

Optional actualVisibleMinimumValue

actualVisibleMinimumValue: number | string

Gets the effective minimum value for the current numeric axis object.

The actualVisibleMinimumValue is used to get the current visible maximum value for the a numeric axis. Note, at times the actualVisibleMinimumValue may differ from the actualMinimumValue, for example when the chart is zoomed.

let effectiveVisibleMinValue: number = yAxis.actualVisibleMinimumValue;

Optional coercionMethods

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 re-imported into the chart.

The coercionMethods methods is 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.

Optional crossingAxis

crossingAxis: IgrAxis

Gets or sets the CrossingAxis property.

The crossingAxis property is used for CrossingAxis .

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

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis"
         crossingAxisName= "xAxis"
        crossingValue= {700}/>
 </IgrDataChart>

Optional crossingAxisName

crossingAxisName: string

Optional crossingValue

crossingValue: any

Gets or sets the CrossingValue property.

The crossingValue property is used for CrossingValue of the axis.

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

    <IgrNumericXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis"
         crossingAxis= "xAxis"
        crossingValue= {700}/>
 </IgrDataChart>

Optional enhancedIntervalMinimumCharacters

enhancedIntervalMinimumCharacters: number | string

Gets or sets the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.

The enhancedIntervalMinimumCharacters property is used to set the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics.

Optional expectFunctions

expectFunctions: boolean | string

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.

Optional formatLabel

formatLabel: function

Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

The formatLabel function takes an object that produces a formatted label for displaying in the chart.

<IgrDataChart dataSource={this.data}   >
    <IgrCategoryXAxis
        name="xAxis"
        FormatLabel="xAxis_FormatLabel" />
</IgrDataChart>

Type declaration

    • (item: any): string
    • Parameters

      • item: any

      Returns string

Optional interval

interval: number | string

Gets or sets the Interval property.

The interval is used to get or set the numeric axis major interval which specifies how frequent major gridlines and axis labels are rendered on an axis.

this.yAxis.interval = 20;
<IgrDataChart >


    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    minimumValue={-900}
    labelLocation="OutsideLeft"
    maximumValue={900}
    interval={300} />


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional isDisabled

isDisabled: boolean | string

Gets or sets the IsDisabled property. If true, the axis will not be rendered.

The isDisabled property is used to decide if the axis will not be rendered.

Optional isInverted

isInverted: boolean | string

Gets or sets the IsInverted property.

Gets or sets the isInverted property.

Optional isLogarithmic

isLogarithmic: boolean | string

Gets or sets the IsLogarithmic property.

isLogarithmic is used to get or set whether the numeric axis scaler is in linear or logarithmic mode. For logarithmic scaling, this can be used in conjunction with logarithmBase to further define the logarithmic scale.

this.yAxis.isLogarithmic= true;
this.yAxis.logarithmBase = 2;
<IgrDataChart >


    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    IsLogarithmic="True"
    LogarithmBase={2}/>


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional label

label: any

Gets or sets the axis label format string.

The label property is used for label mapping of the axis labels.

<IgrCategoryXAxis name="xAxis"
    label="Country"
    labelTextStyle="9pt Verdana"
    labelTopMargin={5}
    labelTextColor="gray" />

Optional labelAngle

labelAngle: number | string

Gets or sets the angle of the {0}.

The Angle property is used to set the angle of the axis.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        titleAngle={90} />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional labelBottomMargin

labelBottomMargin: number | string

Margin applied below the {0}.

The labelBottomMargin is used to set the bottom margin of the labels.

Optional labelExtent

labelExtent: number | string

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"/>
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>

Optional labelHorizontalAlignment

labelHorizontalAlignment: HorizontalAlignment | string

Gets or sets the horizontal alignment of the {0}.

The HorizontalAlignment property is used for the horizontal alignment.

Optional labelLeftMargin

labelLeftMargin: number | string

Margin applied to the left of the {0}.

The labelLeftMargin property is used for the left margin of the labels.

Optional labelLocation

labelLocation: AxisLabelsLocation | string

Gets or sets the location of the {0}.

The Location property is used for the location.

Optional labelRightMargin

labelRightMargin: number | string

Margin applied to the right of the {0}.

The labelRightMargin property is used for the right margin of the labels.

Optional labelShowFirstLabel

labelShowFirstLabel: boolean | string

Gets or sets whether the first label is displayed when the zoom level is set to 1.

The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

Optional labelTextColor

labelTextColor: string

The color of the {0}.

The labelTextColor property Overrides the color of the text used for the axis labels.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        labelTextColor="gray"  />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional labelTextStyle

labelTextStyle: string

Gets or sets the text style to use for axis labels.

The labelTextStyle property Overrides the style of the text used for the axis labels.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        titleTextStyle="12pt Verdana" />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional labelTopMargin

labelTopMargin: number | string

Margin applied above the {0}.

The labelTopMargin property is used for the top margin of the labels.

<IgrCategoryXAxis name="xAxis"
    label="Country"
    labelTextStyle="9pt Verdana"
    labelTopMargin={5}
    labelTextColor="gray" />

Optional labelVerticalAlignment

labelVerticalAlignment: VerticalAlignment | string

Gets or sets the vertical alignment of the {0}.

The VerticalAlignment property is used for the vertical alignment of the axis.

Optional labelVisibility

labelVisibility: Visibility | string

Gets or sets the visibility of the {0}.

The Visibility property is used for the visibility of the axis.

Optional logarithmBase

logarithmBase: number | string

Gets or sets the LogarithmBase property.

logarithmBase is used to get or set logarithm base when a numeric axis is in Logarithmic scale mode. For logarithmic scaling, this is used in conjunction with isLogarithmic or ScaleMode to set logarithmic scaling.

this.yAxis.scaleMode = NumericScaleMode.Logarithmic;
this.yAxis.logarithmBase = 2;
<IgrDataChart >


    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    ScaleMode="Logarithmic"
    LogarithmBase={2}/>

    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional majorStroke

majorStroke: string

Gets or sets the MajorStroke property. Null is treated as auto. Major lines will be displayed or not based on the axis type and series used with it.

Gets or sets the majorStroke using this property.

<IgrNumericYAxis name="yAxis"
    interval={100}
    majorStroke="black"
    majorStrokeThickness={1}
    minorInterval={25}
    minorStroke="gray"
    minorStrokeThickness={0.5} />

Optional majorStrokeThickness

majorStrokeThickness: number | string

Gets or sets the MajorStrokeThickness property.

Gets or sets the majorStrokeThickness using this property.

<IgrNumericYAxis name="yAxis"
    interval={100}
    majorStroke="black"
    majorStrokeThickness={1}
    minorInterval={25}
    minorStroke="gray"
    minorStrokeThickness={0.5} />

Optional maximumValue

maximumValue: number | string

Gets or sets the MaximumValue property.

Used to set the maximum value of a numeric axis. To get the maximum value in effect on a numeric axis use actualMaximumValue.

this.yAxis.maximumValue = 80;
<IgrDataChart >


    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    minimumValue={-900}
    labelLocation="OutsideLeft"
    interval={300} />


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional minimumValue

minimumValue: number | string

Gets or sets the MinimumValue property.

Used to set the minimum value of a numeric axis. To get the minimum value in effect on a numeric axis use actualMinimumValue.

this.yAxis.minimumValue = 0;
<IgrDataChart >


    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    minimumValue={-900}
    labelLocation="OutsideLeft"
    maximumValue={900}
    interval={300} />


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional minorInterval

minorInterval: number | string

Gets or sets the MinorInterval property.

The minorInterval is used to get or set the numeric axis minor interval which specifies how frequent minor gridlines are rendered on an axis. Please note, in order for minor gridlines to be displayed the following may also need to be set: MinorStroke, MinorStrokeThickness.

this.yAxis.minorInterval = 2.5;
this.yAxis.minorStroke = 'blue';
this.yAxis.minorStrokeThickness = 1;
<IgrDataChart >

    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    minimumValue={-900}
    minorInterval= 2.5
    minorStroke="blue" />


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional minorStroke

minorStroke: string

Gets or sets the MinorStroke property.

Gets or sets the minorStroke thickness using minorStrokeThickness property.

<IgrNumericYAxis name="yAxis"
    interval={100}
    majorStroke="black"
    majorStrokeThickness={1}
    minorInterval={25}
    minorStroke="gray"
    minorStrokeThickness={0.5} />

Optional minorStrokeThickness

minorStrokeThickness: number | string

Gets or sets the MinorStrokeThickness property.

name

name: string

Sets or gets a required unique name for the axis.

Optional rangeChanged

rangeChanged: function

Occurs when the axis range changes.

Type declaration

Optional referenceValue

referenceValue: number | string

Gets or sets the ReferenceValue property.

Used to get or set a reference value on a numeric axis which when used with an area, bar, or column series will result in the series shapes being drawn above or below the specified value.

this.yAxis.referenceValue = 30;
<IgrDataChart >

    <IgrCategoryXAxis name="xAxisYears"
    interval={12} labelLocation="OutsideBottom"
    label="Year"  overlap={1} gap={0.4}  />

    <IgrNumericYAxis  name="yAxisLeft"
    title="Expanse | Revenue"
    referenceValue= {30} />


    <IgrLineSeries name="series1"
    valueMemberPath="Revenue"
    xAxisName="xAxisMonths"
    yAxisName="yAxisLeft" />
 </IgrDataChart>

Optional renderRequested

renderRequested: function

This event is raised every time a render has been requested from a series.

Type declaration

Optional scaleMode

scaleMode: NumericScaleMode | string

Gets or sets the axis scale mode.

scaleMode can be used on numeric axes to allow scaling data values using built-in scalers. The available scalers are linear or logarithmic.

this.yAxis.scaleMode = NumericScaleMode.Logarithmic;
 <IgrDataChart
    dataSource={this.state.dataSource} >

    <IgrCategoryXAxis name="xAxis" />
    <IgrNumericYAxis name="yAxis"
    scaleMode="logarithmic" />

    <IgrLineSeries
     name="series1"
    xAxisName="xAxis"
    yAxisName="yAxis"
    valueMemberPath="Value" />
 </IgrDataChart>

Optional strip

strip: string

Gets or sets the Strip property.

Use strip property to set the strip of the chart.

<IgrCategoryChart
        ref={this.onChartRef}
        width="100%"
        height="100%"
        dataSource={this.data}
        titleTopMargin={5}
        xAxisStrip="gray"/>

Optional stroke

stroke: string

Gets or sets the Stroke property. Null is treated as auto. The axis stroke will be displayed or not based on the axis type and series used with it.

Use stroke property to set the stroke of the chart.

<IgrCategoryChart
        ref={this.onChartRef}
        width="100%"
        height="100%"
        dataSource={this.data}
        titleTopMargin={5}
        xAxisStroke="gray"/>

Optional strokeThickness

strokeThickness: number | string

Gets or sets the StrokeThickness property.

Use strokeThickness property for the thickness of the stroke.

<IgrCategoryChart
        ref={this.onChartRef}
        width="100%"
        height="100%"
        dataSource={this.data}
        titleTopMargin={5}
        xAxisStrokeThickness={2}>

Optional tickLength

tickLength: number | string

Gets or sets the TickLength property.

Use tickLength property for The length of the tickmarks to display for this axis.

<IgrCategoryXAxis name="xAxis"
    tickLength={10}
    tickStrokeThickness={0.5}
    tickStroke="black" />

Optional tickStroke

tickStroke: string

Gets or sets the TickStroke property.

Use tickStroke property for the color of the tickmarks.

<IgrCategoryXAxis name="xAxis"
    tickLength={10}
    tickStrokeThickness={0.5}
    tickStroke="black" />

Optional tickStrokeThickness

tickStrokeThickness: number | string

Gets or sets the TickStrokeThickness property.

Use tickStrokeThickness property for thickness of the stroke tickmarks.

<IgrCategoryXAxis name="xAxis"
    tickLength={10}
    tickStrokeThickness={0.5}
    tickStroke="black" />

Optional title

title: string

Gets or sets the Title property.

Use title property to display the title of the component.

<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional titleAngle

titleAngle: number | string

Gets or sets the angle of the {0}.

The Angle property is used to set the angle of the axis.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        titleAngle={90} />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional titleBottomMargin

titleBottomMargin: number | string

Margin applied below the {0}.

The labelBottomMargin is used to set the bottom margin of the labels.

Optional titleExtent

titleExtent: number | string

Distance between the axis and the edge of the control.

The Extent property is used for the extent.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"/>
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>

Optional titleHorizontalAlignment

titleHorizontalAlignment: HorizontalAlignment | string

Gets or sets the horizontal alignment of the {0}.

The HorizontalAlignment property is used for the horizontal alignment.

Optional titleLeftMargin

titleLeftMargin: number | string

Margin applied to the left of the {0}.

The labelLeftMargin property is used for the left margin of the labels.

Optional titleLocation

titleLocation: AxisLabelsLocation | string

Gets or sets the location of the {0}.

The Location property is used for the location.

Optional titlePosition

titlePosition: AxisTitlePosition | string

Gets or sets the title position relative to the axis labels.

Optional titleRightMargin

titleRightMargin: number | string

Margin applied to the right of the {0}.

The labelRightMargin property is used for the right margin of the labels.

Optional titleShowFirstLabel

titleShowFirstLabel: boolean | string

Gets or sets whether the first label is displayed when the zoom level is set to 1.

The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

Optional titleTextColor

titleTextColor: string

The color of the {0}.

The labelTextColor property Overrides the color of the text used for the axis labels.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        labelTextColor="gray"  />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional titleTextStyle

titleTextStyle: string

Gets or sets the text style to use for axis labels.

The labelTextStyle property Overrides the style of the text used for the axis labels.

<IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">

    <IgrCategoryXAxis name="xAxis"
        label="Year"
        titleTextStyle="12pt Verdana" />
    <IgrNumericYAxis  name="yAxis" />
 </IgrDataChart>
<IgrCategoryXAxis name="xAxis"
    title="Country"
    titleTextColor="gray"
    titleTextStyle="12pt Verdana"
    titleAngle={90} />

Optional titleTopMargin

titleTopMargin: number | string

Margin applied above the {0}.

The labelTopMargin property is used for the top margin of the labels.

<IgrCategoryXAxis name="xAxis"
    label="Country"
    labelTextStyle="9pt Verdana"
    labelTopMargin={5}
    labelTextColor="gray" />

Optional titleVerticalAlignment

titleVerticalAlignment: VerticalAlignment | string

Gets or sets the vertical alignment of the {0}.

The VerticalAlignment property is used for the vertical alignment of the axis.

Optional titleVisibility

titleVisibility: Visibility | string

Gets or sets the visibility of the {0}.

The Visibility property is used for the visibility of the axis.

Optional useEnhancedIntervalManagement

useEnhancedIntervalManagement: boolean | string

Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

Use useEnhancedIntervalManagement property to gets/sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.