Class IgrCategoryYAxis<SS>

Represents a IgxDataChartComponent category Y axis.

Type parameters

  • SS

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Accessors

actualInterval

  • get actualInterval(): number
  • set actualInterval(v: number): void
  • Gets the effective value for the current Interval.

    Returns number

  • Gets the effective value for the current Interval.

    Parameters

    • v: number

    Returns void

actualMajorStroke

  • get actualMajorStroke(): string
  • set actualMajorStroke(v: string): void
  • Gets or sets the ActualMajorStroke property.

    The actualMajorStroke property is used for ActualMajorStroke of the axis.

    Returns string

  • Gets or sets the ActualMajorStroke property.

    The actualMajorStroke property is used for ActualMajorStroke of the axis.

    Parameters

    • v: string

    Returns void

actualMinorInterval

  • get actualMinorInterval(): number
  • set actualMinorInterval(v: number): void
  • Gets the effective value for the current MinorInterval.

    Returns number

  • Gets the effective value for the current MinorInterval.

    Parameters

    • v: number

    Returns void

actualMinorStroke

  • get actualMinorStroke(): string
  • set actualMinorStroke(v: string): void
  • Gets or sets the ActualMinorStroke property.

    The actualMinorStroke property is used for ActualMinorStroke of the axis.

    Returns string

  • Gets or sets the ActualMinorStroke property.

    The actualMinorStroke property is used for ActualMinorStroke of the axis.

    Parameters

    • v: string

    Returns void

actualStroke

  • get actualStroke(): string
  • set actualStroke(v: string): void
  • Gets or sets the effective stroke used for the axis.

    Returns string

  • Gets or sets the effective stroke used for the axis.

    Parameters

    • v: string

    Returns void

annotations

axisInternal

  • get axisInternal(): Axis
  • Returns Axis

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

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

    Parameters

    • v: any

    Returns void

crossingAxis

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

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

    Parameters

    Returns void

crossingAxisName

  • get crossingAxisName(): string
  • set crossingAxisName(value: string): void

crossingValue

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

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

    Parameters

    • v: any

    Returns void

dataSource

  • get dataSource(): any
  • set dataSource(value: any): void

enhancedIntervalMinimumCharacters

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

    Returns number

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

    Parameters

    • v: number

    Returns void

expectFunctions

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

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

    Parameters

    • v: boolean

    Returns void

formatLabel

  • get formatLabel(): function
  • set formatLabel(v: function): void
  • 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>

    Returns function

      • (item: any): string
      • Parameters

        • item: any

        Returns string

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

    Parameters

    • v: function
        • (item: any): string
        • Parameters

          • item: any

          Returns string

    Returns void

gap

  • get gap(): number
  • set gap(v: number): void
  • Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

    Use the gap property to configure the spacing between items on a category axis with item spacing.

    A gap of 0 allocates no space between items. A gap of 1 allocates a space between items equal to the width of one item.

    To set the item spacing to 75% the width of one item, set the gap to 0.75, as in this code:

     <IgrDataChart
        ref={this.onChartRef}
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" gap={0.4} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
     </IgrDataChart>

    Returns number

  • Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

    Use the gap property to configure the spacing between items on a category axis with item spacing.

    A gap of 0 allocates no space between items. A gap of 1 allocates a space between items equal to the width of one item.

    To set the item spacing to 75% the width of one item, set the gap to 0.75, as in this code:

     <IgrDataChart
        ref={this.onChartRef}
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" gap={0.4} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
     </IgrDataChart>

    Parameters

    • v: number

    Returns void

interval

  • get interval(): number
  • set interval(v: number): void
  • Gets or sets the frequency of displayed labels. The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

    Returns number

  • Gets or sets the frequency of displayed labels. The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

    Parameters

    • v: number

    Returns void

isAngular

  • get isAngular(): boolean
  • Gets if the current axis is of angular axis type

    Returns boolean

isCategory

  • get isCategory(): boolean

isCategoryDateTime

  • get isCategoryDateTime(): boolean
  • Gets if the current axis is of category date time axis type

    Returns boolean

isContinuous

  • get isContinuous(): boolean

isDateTime

  • get isDateTime(): boolean
  • Gets or sets if the current axis is of date time axis type

    Returns boolean

isDisabled

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isInverted

  • get isInverted(): boolean
  • set isInverted(v: boolean): void
  • Gets or sets the IsInverted property.

    Gets or sets the isInverted property.

    Returns boolean

  • Gets or sets the IsInverted property.

    Gets or sets the isInverted property.

    Parameters

    • v: boolean

    Returns void

isNumeric

  • get isNumeric(): boolean
  • Gets or sets if the current axis is of numeric axis type

    Gets or sets if the current axis is of numeric axis type

    Returns boolean

isPiecewise

  • get isPiecewise(): boolean
  • Gets or sets if the axis is a piecewise scaling function.

    Returns boolean

isRadial

  • get isRadial(): boolean
  • Gets or sets if the current axis is of radial axis type

    Returns boolean

isSorting

  • get isSorting(): boolean
  • Gets or sets if the current axis is sorting data items

    Returns boolean

isVertical

  • get isVertical(): boolean
  • Gets if the current axis is a vertical axis.

    Returns boolean

itemsCount

  • get itemsCount(): number
  • set itemsCount(v: number): void
  • Gets the number of items in the current category axis items source.

    Returns number

  • Gets the number of items in the current category axis items source.

    Parameters

    • v: number

    Returns void

label

  • get label(): any
  • set label(v: any): void
  • 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" />

    Returns 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" />

    Parameters

    • v: any

    Returns void

labelAngle

  • get labelAngle(): number
  • set labelAngle(v: number): void
  • 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} />

    Returns number

  • 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} />

    Parameters

    • v: number

    Returns void

labelBottomMargin

  • get labelBottomMargin(): number
  • set labelBottomMargin(v: number): void
  • Margin applied below the {0}.

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

    Returns number

  • Margin applied below the {0}.

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

    Parameters

    • v: number

    Returns void

labelExtent

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

    Returns number

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

    Parameters

    • v: number

    Returns void

labelHorizontalAlignment

  • get labelHorizontalAlignment(): HorizontalAlignment
  • set labelHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

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

    The HorizontalAlignment property is used for the horizontal alignment.

    Parameters

    • v: HorizontalAlignment

    Returns void

labelLeftMargin

  • get labelLeftMargin(): number
  • set labelLeftMargin(v: number): void
  • Margin applied to the left of the {0}.

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

    Returns number

  • Margin applied to the left of the {0}.

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

    Parameters

    • v: number

    Returns void

labelLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Returns AxisLabelsLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Parameters

    Returns void

labelRightMargin

  • get labelRightMargin(): number
  • set labelRightMargin(v: number): void
  • Margin applied to the right of the {0}.

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

    Returns number

  • Margin applied to the right of the {0}.

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

    Parameters

    • v: number

    Returns void

labelShowFirstLabel

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

labelTextColor

  • get labelTextColor(): string
  • set labelTextColor(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

labelTextStyle

  • get labelTextStyle(): string
  • set labelTextStyle(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

labelTopMargin

  • get labelTopMargin(): number
  • set labelTopMargin(v: number): void
  • 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" />

    Returns number

  • 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" />

    Parameters

    • v: number

    Returns void

labelVerticalAlignment

  • get labelVerticalAlignment(): VerticalAlignment
  • set labelVerticalAlignment(v: VerticalAlignment): void
  • Gets or sets the vertical alignment of the {0}.

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

    Returns VerticalAlignment

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

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

    Parameters

    • v: VerticalAlignment

    Returns void

labelVisibility

  • get labelVisibility(): Visibility
  • set labelVisibility(v: Visibility): void
  • Gets or sets the visibility of the {0}.

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

    Returns Visibility

  • Gets or sets the visibility of the {0}.

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

    Parameters

    • v: Visibility

    Returns void

majorStroke

  • get majorStroke(): string
  • set majorStroke(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

majorStrokeThickness

  • get majorStrokeThickness(): number
  • set majorStrokeThickness(v: number): void
  • 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} />

    Returns number

  • 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} />

    Parameters

    • v: number

    Returns void

minorInterval

  • get minorInterval(): number
  • set minorInterval(v: number): void
  • Gets or sets the frequency of displayed minor lines. The set value is a factor that determines how the minor lines will be displayed.

    Returns number

  • Gets or sets the frequency of displayed minor lines. The set value is a factor that determines how the minor lines will be displayed.

    Parameters

    • v: number

    Returns void

minorStroke

  • get minorStroke(): string
  • set minorStroke(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

minorStrokeThickness

  • get minorStrokeThickness(): number
  • set minorStrokeThickness(v: number): void
  • Gets or sets the MinorStrokeThickness property.

    Returns number

  • Gets or sets the MinorStrokeThickness property.

    Parameters

    • v: number

    Returns void

name

  • get name(): string
  • set name(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

overlap

  • get overlap(): number
  • set overlap(v: number): void
  • Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

    Use the overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

    An overlap of 0 places grouped items adjacent to each other. An overlap of 1 places grouped items in the same axis space, completely overlapping. An overlap of -1 places a space between grouped items equal to the width of one item.

    To place grouped items with 75% overlap, set the overlap to 0.75, as in this code:

     <IgrDataChart
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" overlap={1} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value"
    />
     </IgrDataChart>

    Returns number

  • Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

    Use the overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

    An overlap of 0 places grouped items adjacent to each other. An overlap of 1 places grouped items in the same axis space, completely overlapping. An overlap of -1 places a space between grouped items equal to the width of one item.

    To place grouped items with 75% overlap, set the overlap to 0.75, as in this code:

     <IgrDataChart
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" overlap={1} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value"
    />
     </IgrDataChart>

    Parameters

    • v: number

    Returns void

rangeChanged

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

renderRequested

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

strip

  • get strip(): string
  • set strip(v: string): void
  • 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"/>

    Returns 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"/>

    Parameters

    • v: string

    Returns void

stroke

  • get stroke(): string
  • set stroke(v: string): void
  • 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"/>

    Returns 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"/>

    Parameters

    • v: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(v: number): void
  • 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}>

    Returns number

  • 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}>

    Parameters

    • v: number

    Returns void

tickLength

  • get tickLength(): number
  • set tickLength(v: number): void
  • 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" />

    Returns number

  • 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" />

    Parameters

    • v: number

    Returns void

tickStroke

  • get tickStroke(): string
  • set tickStroke(v: string): void
  • 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" />

    Returns 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" />

    Parameters

    • v: string

    Returns void

tickStrokeThickness

  • get tickStrokeThickness(): number
  • set tickStrokeThickness(v: number): void
  • 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" />

    Returns number

  • 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" />

    Parameters

    • v: number

    Returns void

title

  • get title(): string
  • set title(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

titleAngle

  • get titleAngle(): number
  • set titleAngle(v: number): void
  • 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} />

    Returns number

  • 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} />

    Parameters

    • v: number

    Returns void

titleBottomMargin

  • get titleBottomMargin(): number
  • set titleBottomMargin(v: number): void
  • Margin applied below the {0}.

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

    Returns number

  • Margin applied below the {0}.

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

    Parameters

    • v: number

    Returns void

titleExtent

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

    Returns number

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

    Parameters

    • v: number

    Returns void

titleHorizontalAlignment

  • get titleHorizontalAlignment(): HorizontalAlignment
  • set titleHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

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

    The HorizontalAlignment property is used for the horizontal alignment.

    Parameters

    • v: HorizontalAlignment

    Returns void

titleLeftMargin

  • get titleLeftMargin(): number
  • set titleLeftMargin(v: number): void
  • Margin applied to the left of the {0}.

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

    Returns number

  • Margin applied to the left of the {0}.

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

    Parameters

    • v: number

    Returns void

titleLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Returns AxisLabelsLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Parameters

    Returns void

titlePosition

titleRightMargin

  • get titleRightMargin(): number
  • set titleRightMargin(v: number): void
  • Margin applied to the right of the {0}.

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

    Returns number

  • Margin applied to the right of the {0}.

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

    Parameters

    • v: number

    Returns void

titleShowFirstLabel

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

titleTextColor

  • get titleTextColor(): string
  • set titleTextColor(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

titleTextStyle

  • get titleTextStyle(): string
  • set titleTextStyle(v: string): void
  • 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} />

    Returns 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} />

    Parameters

    • v: string

    Returns void

titleTopMargin

  • get titleTopMargin(): number
  • set titleTopMargin(v: number): void
  • 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" />

    Returns number

  • 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" />

    Parameters

    • v: number

    Returns void

titleVerticalAlignment

  • get titleVerticalAlignment(): VerticalAlignment
  • set titleVerticalAlignment(v: VerticalAlignment): void
  • Gets or sets the vertical alignment of the {0}.

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

    Returns VerticalAlignment

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

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

    Parameters

    • v: VerticalAlignment

    Returns void

titleVisibility

  • get titleVisibility(): Visibility
  • set titleVisibility(v: Visibility): void
  • Gets or sets the visibility of the {0}.

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

    Returns Visibility

  • Gets or sets the visibility of the {0}.

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

    Parameters

    • v: Visibility

    Returns void

useClusteringMode

  • get useClusteringMode(): boolean
  • set useClusteringMode(v: boolean): void
  • Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

    useClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

    Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

     <IgrDataChart
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" useClusteringMode={2} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
     </IgrDataChart>

    Returns boolean

  • Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

    useClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

    Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

     <IgrDataChart
        dataSource={this.state.dataSource} >
    
        <IgrCategoryXAxis name="xAxis" useClusteringMode={2} />
        <IgrNumericYAxis name="yAxis" />
    
        <IgrColumnSeries
         name="series1"
        xAxisName="xAxis"
        yAxisName="yAxis"
        valueMemberPath="Value" />
     </IgrDataChart>

    Parameters

    • v: boolean

    Returns void

useEnhancedIntervalManagement

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrCategoryYAxisProps>, nextState: Readonly<__type>, nextContext: any): 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

  • componentDidUpdate(prevProps: Readonly<IIgrCategoryYAxisProps>, prevState: Readonly<__type>, snapshot?: SS): void
  • 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

  • componentWillUpdate(nextProps: Readonly<IIgrCategoryYAxisProps>, nextState: Readonly<__type>, nextContext: any): void

ensureLabelSettings

  • ensureLabelSettings(): void

ensureTitleSettings

  • ensureTitleSettings(): void

getCategoryBoundingBox

  • getCategoryBoundingBox(point: IgPoint, useInterpolation: boolean, singularWidth: number): IgRect

getCategoryBoundingBoxHelper

  • getCategoryBoundingBoxHelper(point: IgPoint, useInterpolation: boolean, singularWidth: number, isVertical: boolean): IgRect
  • Parameters

    • point: IgPoint
    • useInterpolation: boolean
    • singularWidth: number
    • isVertical: boolean

    Returns IgRect

getItemValue

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

    • item: any
    • memberPathName: string

    Returns any

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrCategoryYAxisProps>, prevState: Readonly<__type>): SS | null
  • 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

getValueLabel

  • getValueLabel(value: number): string
  • Gets the label for a data item.

    Parameters

    • value: number
      • The unscaled value to get a label for.

    Returns string

notifyClearItems

  • notifyClearItems(): void
  • Used to manually notify the axis that the data source has reset or cleared its items.

    Returns void

notifyInsertItem

  • notifyInsertItem(index: number, newItem: any): void

notifyRemoveItem

  • notifyRemoveItem(index: number, oldItem: any): void

notifySetItem

  • notifySetItem(index: number, oldItem: any, newItem: any): void
  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

provideData

  • provideData(data: any[]): void

render

  • render(): any
  • Returns any

renderAxis

  • renderAxis(): void
  • Renders the axis with no animation.

    Returns void

resetCachedEnhancedInterval

  • resetCachedEnhancedInterval(): void
  • If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.

    Returns void

scaleValue

  • scaleValue(unscaledValue: number): number
  • Scales a value from axis space into screen space.

    Parameters

    • unscaledValue: number
      • The unscaled axis value to scale.

    Returns number

scrollIntoView

  • scrollIntoView(item: any): void
  • Scrolls the specified item into view.

    Parameters

    • item: any
      • Data item to scroll into view

    Returns void

scrollRangeIntoView

  • scrollRangeIntoView(minimum: number, maximum: number): void
  • Parameters

    • minimum: number
    • maximum: number

    Returns void

shouldComponentUpdate

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

    • nextProps: any
    • nextState: any

    Returns boolean

unscaleValue

  • unscaleValue(unscaledValue: number): number
  • Unscales a value from screen space into axis space.

    Parameters

    • unscaledValue: number
      • The scaled value in screen coordinates to unscale into axis space.

    Returns number

Static _createFromInternal

  • _createFromInternal(internal: any): IgrAxis