Class IgxNumericYAxisComponent

Hierarchy

Implements

  • OnInit

Constructors

Accessors

Methods

Constructors

constructor

Accessors

abbreviateLargeNumbers

  • get abbreviateLargeNumbers(): boolean
  • set abbreviateLargeNumbers(v: boolean): void

actualInterval

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

    let effectiveInterval: number = yAxis.actualInterval;

    Returns number

  • Gets the effective value for the current Interval.

    let effectiveInterval: number = yAxis.actualInterval;

    Parameters

    • v: number

    Returns void

actualIsLogarithmic

  • get actualIsLogarithmic(): boolean
  • set actualIsLogarithmic(v: boolean): void
  • Determines if the axis has a valid logarithmic scale.

    let effectiveLogarithmic: boolean = this.yAxis.actualIsLogarithmic

    Returns boolean

  • Determines if the axis has a valid logarithmic scale.

    let effectiveLogarithmic: boolean = this.yAxis.actualIsLogarithmic

    Parameters

    • v: boolean

    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

actualMaximumValue

  • get actualMaximumValue(): number
  • set actualMaximumValue(v: number): void
  • Gets the effective maximum value for the current numeric axis object.

    let effectiveMaxValue: number = yAxis.actualMaximumValue;

    Returns number

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

    let effectiveMaxValue: number = yAxis.actualMaximumValue;

    Parameters

    • v: number

    Returns void

actualMinimumValue

  • get actualMinimumValue(): number
  • set actualMinimumValue(v: number): void
  • Gets the effective minimum value for the current numeric axis object.

    let effectiveMinValue: number = yAxis.actualMinimumValue;

    Returns number

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

    let effectiveMinValue: number = yAxis.actualMinimumValue;

    Parameters

    • v: number

    Returns void

actualMinorInterval

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

    let effectiveMinorInterval: number = yAxis.actualMinorInterval;

    Returns number

  • Gets the effective value for the current MinorInterval.

    let effectiveMinorInterval: number = yAxis.actualMinorInterval;

    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

actualVisibleMaximumValue

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

    Returns number

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

    Parameters

    • v: number

    Returns void

actualVisibleMinimumValue

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

    Returns number

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

    Parameters

    • v: number

    Returns void

annotations

  • get annotations(): AxisAnnotationCollection
  • set annotations(v: AxisAnnotationCollection): void
  • Gets the current annotations for the axis.

    Returns AxisAnnotationCollection

  • Gets the current annotations for the axis.

    Parameters

    • v: AxisAnnotationCollection

    Returns void

axisInternal

  • get axisInternal(): 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 of the axis.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            crossingAxis= "xAxis"
            crossingValue= 700
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Returns IgxAxisComponent

  • Gets or sets the CrossingAxis property.

    The crossingAxis property is used for CrossingAxis of the axis.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            crossingAxis= "xAxis"
            crossingValue= 700
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Parameters

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

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            crossingAxis= "xAxis"
            crossingValue= 700
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Returns any

  • Gets or sets the CrossingValue property.

    The crossingValue property is used for CrossingValue of the axis.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            crossingAxis= "xAxis"
            crossingValue= 700
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Parameters

    • v: any

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

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            enhancedIntervalMinimumCharacters=5
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            enhancedIntervalMinimumCharacters=5
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart [dataSource]="data" >
        <igx-category-x-axis
            name="xAxis"
            FormatLabel="xAxis_FormatLabel" />
    </igx-data-chart>

    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.

    <igx-data-chart [dataSource]="data" >
        <igx-category-x-axis
            name="xAxis"
            FormatLabel="xAxis_FormatLabel" />
    </igx-data-chart>

    Parameters

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

          • item: any

          Returns string

    Returns void

hasUserMaximum

  • get hasUserMaximum(): boolean
  • Determines if the axis has a user-defined maximum.

    hasUserMinimum is used to determine if a numeric axis has a user definied minium value.

    let hasSetMinimum: boolean = this.yAxis.hasUserMinimum;

    Returns boolean

hasUserMinimum

  • get hasUserMinimum(): boolean
  • Determines if the axis has a user-defined minimum.

    hasUserMaximum is used to determine if a numeric axis has a user definied maximum value.

    let hasSetMaximum: boolean = this.yAxis.hasUserMaximum;

    Returns boolean

interval

  • get interval(): number
  • set interval(v: number): void
  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis
            >
          </igx-category-x-axis>
          <igx-numeric-y-axis
            interval="20"
            #yAxis>
          </igx-numeric-y-axis>
    
          <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-column-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis
            >
          </igx-category-x-axis>
          <igx-numeric-y-axis
            interval="20"
            #yAxis>
          </igx-numeric-y-axis>
    
          <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-column-series>
    </igx-data-chart>

    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
  • Gets or sets if the current axis is of category axis type

    Returns boolean

isCategoryDateTime

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

    Returns boolean

isContinuous

  • get isContinuous(): boolean
  • Gets if the current axis is a continuous rather than a discrete scale

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

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            isInverted= true
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns boolean

  • Gets or sets the IsInverted property.

    Gets or sets the isInverted property.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            isInverted= true
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Parameters

    • v: boolean

    Returns void

isLogarithmic

  • get isLogarithmic(): boolean
  • set isLogarithmic(v: boolean): void
  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis>
          </igx-category-x-axis>
          <igx-numeric-y-axis
            isLogarithmic=true
            logarithmBase=2
            #yAxis>
          </igx-numeric-y-axis>
          <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-line-series>
    </igx-data-chart>

    Returns boolean

  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis>
          </igx-category-x-axis>
          <igx-numeric-y-axis
            isLogarithmic=true
            logarithmBase=2
            #yAxis>
          </igx-numeric-y-axis>
          <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-line-series>
    </igx-data-chart>

    Parameters

    • v: boolean

    Returns void

isNumeric

  • get isNumeric(): 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 of vertical axis

    Returns boolean

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.

    Returns any

  • Gets or sets the axis label format string.

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

    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.

    Returns number

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

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

    Parameters

    • v: number

    Returns void

labelBottomMargin

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

    The labelBottomMargin is used for the bottom margin of the labels.

    Returns number

  • Margin applied below the {0}.

    The labelBottomMargin is used for 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.

    Returns number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Parameters

    • v: number

    Returns void

labelHorizontalAlignment

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

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.

    Returns string

  • The color of the {0}.

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

    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.

    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.

    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.

    Returns number

  • Margin applied above the {0}.

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

    Parameters

    • v: number

    Returns void

labelVerticalAlignment

labelVisibility

  • 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

    Returns void

logarithmBase

  • get logarithmBase(): number
  • set logarithmBase(v: number): void
  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis>
          </igx-category-x-axis>
          <igx-numeric-y-axis
            scaleMode="Logarithmic"
            logarithmBase=2
            #yAxis>
          </igx-numeric-y-axis>
          <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-line-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
          [dataSource]="data">
          <igx-category-x-axis
            label="label"
            #xAxis>
          </igx-category-x-axis>
          <igx-numeric-y-axis
            scaleMode="Logarithmic"
            logarithmBase=2
            #yAxis>
          </igx-numeric-y-axis>
          <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
          </igx-line-series>
    </igx-data-chart>

    Parameters

    • v: number

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
           majorStroke="black"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
           majorStroke="black"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
          majorStrokeThickness="1"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Returns number

  • Gets or sets the MajorStrokeThickness property.

    Gets or sets the majorStrokeThickness using this property.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
          majorStrokeThickness="1"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Parameters

    • v: number

    Returns void

maximumValue

  • get maximumValue(): number
  • set maximumValue(v: number): void
  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            maximumValue=80
            #yAxis>
        </igx-numeric-y-axis>
        <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-line-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            maximumValue=80
            #yAxis>
        </igx-numeric-y-axis>
        <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-line-series>
    </igx-data-chart>

    Parameters

    • v: number

    Returns void

minimumValue

  • get minimumValue(): number
  • set minimumValue(v: number): void
  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            minimumValue=0
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            minimumValue=0
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    Parameters

    • v: number

    Returns void

minorInterval

  • get minorInterval(): number
  • set minorInterval(v: number): void
  • 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;
    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            minorInterval= 2.5
            minorStroke="blue"
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            minorInterval= 2.5
            minorStroke="blue"
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
         minorStrokeThickness="1"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Returns string

  • Gets or sets the MinorStroke property.

    Gets or sets the minorStroke thickness using minorStrokeThickness property.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
         minorStrokeThickness="1"
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Parameters

    • v: string

    Returns void

minorStrokeThickness

  • get minorStrokeThickness(): number
  • set minorStrokeThickness(v: number): void

name

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

  • Parameters

    • value: string

    Returns void

rangeChanged

  • get rangeChanged(): EventEmitter<object>
  • Occurs when the axis range changes.

    Returns EventEmitter<object>

referenceValue

  • get referenceValue(): number
  • set referenceValue(v: number): void
  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            referenceValue=30
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    Returns number

  • 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;
    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            referenceValue=30
            #yAxis>
        </igx-numeric-y-axis>
        <igx-column-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-column-series>
    </igx-data-chart>

    Parameters

    • v: number

    Returns void

renderRequested

  • get renderRequested(): EventEmitter<object>
  • This event is raised every time a render has been requested from a series.

    Returns EventEmitter<object>

scaleMode

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

    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis
            scaleMode="logarithmic">
        </igx-numeric-y-axis>
        <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-line-series>
    </igx-data-chart>
    this.yAxis.scaleMode = NumericScaleMode.Logarithmic;

    Returns NumericScaleMode

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

    <igx-data-chart
        [dataSource]="data">
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis
            scaleMode="logarithmic">
        </igx-numeric-y-axis>
        <igx-line-series
            [xAxis]="xAxis"
            [yAxis]="yAxis"
            valueMemberPath="value">
        </igx-line-series>
    </igx-data-chart>
    this.yAxis.scaleMode = NumericScaleMode.Logarithmic;

    Parameters

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

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
             strip= "grey"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns string

  • Gets or sets the Strip property.

    Use strip property to set the strip of the chart.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
             strip= "grey"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            stroke="blue"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            stroke="blue"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            strokeThickness= 5
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns number

  • Gets or sets the StrokeThickness property.

    Use strokeThickness property for the thickness of the stroke.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            strokeThickness= 5
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickLength="5"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns number

  • Gets or sets the TickLength property.

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

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickLength="5"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickStroke="black"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    Returns string

  • Gets or sets the TickStroke property.

    Use tickStroke property for the color of the tickmarks.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickStroke="black"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickStrokeThicknes="2"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns number

  • Gets or sets the TickStrokeThickness property.

    Use tickStrokeThickness property for thickness of the stroke tickmarks.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            tickStrokeThicknes="2"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    Returns string

  • Gets or sets the Title property.

    Use title property to display the title of the component.

    <igx-data-chart
        [dataSource]="data" >
        <igx-category-x-axis
            label="label"
            #xAxis>
        </igx-category-x-axis>
        <igx-numeric-y-axis
            #yAxis>
        </igx-numeric-y-axis>
    
    </igx-data-chart>

    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.

    Returns number

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

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

    Parameters

    • v: number

    Returns void

titleBottomMargin

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

    The labelBottomMargin is used for the bottom margin of the labels.

    Returns number

  • Margin applied below the {0}.

    The labelBottomMargin is used for 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.

    Returns number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Parameters

    • v: number

    Returns void

titleHorizontalAlignment

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

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.

    Returns string

  • The color of the {0}.

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

    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.

    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.

    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.

    Returns number

  • Margin applied above the {0}.

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

    Parameters

    • v: number

    Returns void

titleVerticalAlignment

titleVisibility

  • 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

    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

ensureLabelSettings

  • ensureLabelSettings(): void

ensureTitleSettings

  • ensureTitleSettings(): void

getItemValue

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

    • item: any
    • memberPathName: string

    Returns any

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

ngOnInit

  • ngOnInit(): void

provideData

  • provideData(data: any): void

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

scrollRangeIntoView

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

    • minimum: number
    • maximum: number

    Returns void

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.

      Unscales a value from screen space into axis space.

      let dataValue: number = this.yAxis.unscaleValue(pixel);

    Returns number

Static _createFromInternal