ig.excel.Axis

Represents a single axis in a chart.

Remarks

To change the color of the ticklines, use the ChartLineBase.fill property.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • axisBetweenCategories

    .axisBetweenCategories( );

    True if the value axis crosses the category axis between categories.

  • axisBetweenCategories

    .axisBetweenCategories( value:boolean );

    True if the value axis crosses the category axis between categories.

    • value
    • Type:boolean

  • axisGroup

    .axisGroup( );
    Return Type:
    ig.excel.AxisGroup
    Return Type Description:
    Returns a AxisGroup.

    Returns the group for the specified axis. Read-only

    See Also

  • axisTitle

    .axisTitle( );
    Return Type:
    ig.excel.ChartTitle
    Return Type Description:
    Returns a ChartTitle.

    Returns a ChartTitle object that represents the title of the axis.

    See Also

  • axisTitle

    .axisTitle( value:ig.excel.ChartTitle );
    Return Type:
    ig.excel.ChartTitle
    Return Type Description:
    Returns a ChartTitle.

    Sets a ChartTitle object that represents the title of the axis.

    • value
    • Type:ig.excel.ChartTitle

    See Also

  • baseUnit

    .baseUnit( );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Returns the base unit for the axis.

    Remarks

    Setting this property has no visible effect if the Axis.categoryType property for the specified axis is set to 'CategoryScale'. The set value is retained, however, and takes effect when the CategoryType property is set to 'TimeScale'.

    See Also

  • baseUnit

    .baseUnit( value:ig.excel.TimeUnit );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Sets the base unit for the axis.

    • value
    • Type:ig.excel.TimeUnit

    Remarks

    Setting this property has no visible effect if the Axis.categoryType property for the specified axis is set to 'CategoryScale'. The set value is retained, however, and takes effect when the CategoryType property is set to 'TimeScale'.

    See Also

  • baseUnitIsAuto

    .baseUnitIsAuto( );

    True if Excel chooses appropriate base units for the specified category axis. The default value is True.

  • baseUnitIsAuto

    .baseUnitIsAuto( value:boolean );

    True if Excel chooses appropriate base units for the specified category axis. The default value is True.

    • value
    • Type:boolean

  • categoryType

    .categoryType( );
    Return Type:
    ig.excel.CategoryType
    Return Type Description:
    Returns a CategoryType.

    Returns the category axis type.

    Remarks

    This property applies only to category axes.

    When set to Automatic, the axis will resolve the category type to either CategoryScale or TimeScale, based on the type of the selected data.

    See Also

  • categoryType

    .categoryType( value:ig.excel.CategoryType );
    Return Type:
    ig.excel.CategoryType
    Return Type Description:
    Returns a CategoryType.

    Sets the category axis type.

    • value
    • Type:ig.excel.CategoryType

    Remarks

    This property applies only to category axes.

    When set to Automatic, the axis will resolve the category type to either CategoryScale or TimeScale, based on the type of the selected data.

    See Also

  • chart
    Inherited

    .chart( );
    Return Type:
    ig.excel.WorksheetChart
    Return Type Description:
    Returns a WorksheetChart.

    Returns the owning chart (read-only)

    See Also

  • crosses

    .crosses( );
    Return Type:
    ig.excel.AxisCrosses
    Return Type Description:
    Returns a AxisCrosses.

    Returns the point on the specified axis where the other axis crosses.

    Remarks

    This property is only applicable to a category axis.

    Set this property to Custom to specify a data value as a crossing point, using the Axis.crossesAt property to specify that value.

    See Also

  • crosses

    .crosses( value:ig.excel.AxisCrosses );
    Return Type:
    ig.excel.AxisCrosses
    Return Type Description:
    Returns a AxisCrosses.

    Sets the point on the specified axis where the other axis crosses.

    • value
    • Type:ig.excel.AxisCrosses

    Remarks

    This property is only applicable to a category axis.

    Set this property to Custom to specify a data value as a crossing point, using the Axis.crossesAt property to specify that value.

    See Also

  • crossesAt

    .crossesAt( );

    Returns the point on the Axis at which the perpendicular axis intersects it.

    Remarks

    For a category axis, this value is interpreted as the value of a data point. For example, on a category axis with a minimum data value of 0 and a maximum of 500, setting this property to 250 causes this axis to appear near the center of the plot area.

    For a value axis, this value is interpreted as the one-based number of the category with which this axis should intersect.

    Setting this property causes the Axis.crosses property to change to 'Custom'.

    This property cannot be used on radar charts.

    For 3-D charts, this property indicates where the plane defined by the category axes crosses the value axis.

  • crossesAt

    .crossesAt( value:number );

    Sets the point on the Axis at which the perpendicular axis intersects it.

    • value
    • Type:number

    Remarks

    For a category axis, this value is interpreted as the value of a data point. For example, on a category axis with a minimum data value of 0 and a maximum of 500, setting this property to 250 causes this axis to appear near the center of the plot area.

    For a value axis, this value is interpreted as the one-based number of the category with which this axis should intersect.

    Setting this property causes the Axis.crosses property to change to 'Custom'.

    This property cannot be used on radar charts.

    For 3-D charts, this property indicates where the plane defined by the category axes crosses the value axis.

  • displayUnit

    .displayUnit( );
    Return Type:
    ig.excel.DisplayUnit
    Return Type Description:
    Returns a DisplayUnit.

    Returns the unit label for the value axis.

    See Also

  • displayUnit

    .displayUnit( value:ig.excel.DisplayUnit );
    Return Type:
    ig.excel.DisplayUnit
    Return Type Description:
    Returns a DisplayUnit.

    Sets the unit label for the value axis.

    • value
    • Type:ig.excel.DisplayUnit

    See Also

  • displayUnitCustom

    .displayUnitCustom( );

    If the value of the DisplayUnit property 'Custom' , the DisplayUnitCustom property returns or sets the value of the displayed units. The value must be from 0 through 10E307

  • displayUnitCustom

    .displayUnitCustom( value:number );

    If the value of the DisplayUnit property 'Custom' , the DisplayUnitCustom property returns or sets the value of the displayed units. The value must be from 0 through 10E307

    • value
    • Type:number

  • displayUnitLabel

    .displayUnitLabel( );
    Return Type:
    ig.excel.DisplayUnitLabel
    Return Type Description:
    Returns a DisplayUnitLabel.

    Returns an Axis.displayUnitLabel object.

    See Also

  • displayUnitLabel

    .displayUnitLabel( value:ig.excel.DisplayUnitLabel );
    Return Type:
    ig.excel.DisplayUnitLabel
    Return Type Description:
    Returns a DisplayUnitLabel.

    Sets an Axis.displayUnitLabel object.

    • value
    • Type:ig.excel.DisplayUnitLabel

    See Also

  • gapWidth

    .gapWidth( );

    Returns a value indicating the width of the gaps between data points or series, expressed as a percentage.

    Remarks

    This property is only applicable for Box and Whisker, Histogram, Pareto, and Waterfall charts.

  • gapWidth

    .gapWidth( value:number );

    Sets a value indicating the width of the gaps between data points or series, expressed as a percentage.

    • value
    • Type:number

    Remarks

    This property is only applicable for Box and Whisker, Histogram, Pareto, and Waterfall charts.

  • logBase

    .logBase( );

    Returns the base of the logarithm when you are using log scales.

    Remarks

    Attempting to set this property to a value less than 2 causes an error. The default value is 10.

  • logBase

    .logBase( value:number );

    Sets the base of the logarithm when you are using log scales.

    • value
    • Type:number

    Remarks

    Attempting to set this property to a value less than 2 causes an error. The default value is 10.

  • majorGridLines

    .majorGridLines( );
    Return Type:
    ig.excel.ChartGridLines
    Return Type Description:
    Returns a ChartGridLines.

    Returns a ChartGridLines object which defines the color and weight of the major ticklines.

    See Also

  • majorGridLines

    .majorGridLines( value:ig.excel.ChartGridLines );
    Return Type:
    ig.excel.ChartGridLines
    Return Type Description:
    Returns a ChartGridLines.

    Returns a ChartGridLines object which defines the color and weight of the major ticklines.

    • value
    • Type:ig.excel.ChartGridLines

    See Also

  • majorTickMark

    .majorTickMark( );
    Return Type:
    ig.excel.TickMark
    Return Type Description:
    Returns a TickMark.

    Returns the type of major tick mark for the specified axis.

    See Also

  • majorTickMark

    .majorTickMark( value:ig.excel.TickMark );
    Return Type:
    ig.excel.TickMark
    Return Type Description:
    Returns a TickMark.

    Sets the type of major tick mark for the specified axis.

    • value
    • Type:ig.excel.TickMark

    See Also

  • majorUnit

    .majorUnit( );

    Returns the major interval unit.

    Remarks

    To set the value of this property, use the Axis.setMajorMinorUnit method.

    See Also

  • majorUnitIsAuto

    .majorUnitIsAuto( );

    True if Excel calculates the major units for the value axis.

  • majorUnitIsAuto

    .majorUnitIsAuto( value:boolean );

    True if Excel calculates the major units for the value axis.

    • value
    • Type:boolean

  • majorUnitScale

    .majorUnitScale( );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Returns the major unit scale value for the category axis when the Axis.categoryType property is set to 'TimeScale'.

    See Also

  • majorUnitScale

    .majorUnitScale( value:ig.excel.TimeUnit );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Sets the major unit scale value for the category axis when the Axis.categoryType property is set to 'TimeScale'.

    • value
    • Type:ig.excel.TimeUnit

    See Also

  • maximumScale

    .maximumScale( );

    Returns the maximum value on the value axis.

  • maximumScale

    .maximumScale( value:number );

    Sets the maximum value on the value axis.

    • value
    • Type:number

  • maximumScaleIsAuto

    .maximumScaleIsAuto( );

    True if Excel calculates the maximum value for the value axis.

  • maximumScaleIsAuto

    .maximumScaleIsAuto( value:boolean );

    True if Excel calculates the maximum value for the value axis.

    • value
    • Type:boolean

  • minimumScale

    .minimumScale( );

    Returns the minimum value on the value axis.

  • minimumScale

    .minimumScale( value:number );

    Sets the minimum value on the value axis.

    • value
    • Type:number

  • minimumScaleIsAuto

    .minimumScaleIsAuto( );

    True if Excel calculates the minimum value for the value axis.

  • minimumScaleIsAuto

    .minimumScaleIsAuto( value:boolean );

    True if Excel calculates the minimum value for the value axis.

    • value
    • Type:boolean

  • minorGridLines

    .minorGridLines( );
    Return Type:
    ig.excel.ChartGridLines
    Return Type Description:
    Returns a ChartGridLines.

    Returns a ChartGridLines object which defines the color and weight of the minor ticklines.

    See Also

  • minorGridLines

    .minorGridLines( value:ig.excel.ChartGridLines );
    Return Type:
    ig.excel.ChartGridLines
    Return Type Description:
    Returns a ChartGridLines.

    Returns a ChartGridLines object which defines the color and weight of the minor ticklines.

    • value
    • Type:ig.excel.ChartGridLines

    See Also

  • minorTickMark

    .minorTickMark( );
    Return Type:
    ig.excel.TickMark
    Return Type Description:
    Returns a TickMark.

    Returns the type of minor tick mark for the specified axis.

    See Also

  • minorTickMark

    .minorTickMark( value:ig.excel.TickMark );
    Return Type:
    ig.excel.TickMark
    Return Type Description:
    Returns a TickMark.

    Sets the type of minor tick mark for the specified axis.

    • value
    • Type:ig.excel.TickMark

    See Also

  • minorUnit

    .minorUnit( );

    Returns the minor interval unit.

    Remarks

    To set the value of this property, use the Axis.setMajorMinorUnit method.

    See Also

  • minorUnitIsAuto

    .minorUnitIsAuto( );

    True if Excel calculates the minor units for the value axis.

  • minorUnitIsAuto

    .minorUnitIsAuto( value:boolean );

    True if Excel calculates the minor units for the value axis.

    • value
    • Type:boolean

  • minorUnitScale

    .minorUnitScale( );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Returns the minor unit scale value for the category axis when the Axis.categoryType property is set to 'TimeScale'.

    See Also

  • minorUnitScale

    .minorUnitScale( value:ig.excel.TimeUnit );
    Return Type:
    ig.excel.TimeUnit
    Return Type Description:
    Returns a TimeUnit.

    Sets the minor unit scale value for the category axis when the Axis.categoryType property is set to 'TimeScale'.

    • value
    • Type:ig.excel.TimeUnit

    See Also

  • owner
    Inherited

    .owner( );
    Return Type:
    ig.excel.ChartObject
    Return Type Description:
    The owner or null if this object is owned directly by the Chart

    returns this object's owner. (read-only)

    See Also

  • position

    .position( );
    Return Type:
    ig.excel.AxisPosition
    Return Type Description:
    Returns a AxisPosition.

    Returns an AxisPosition value which determines the placement of the axis as relative to the chart space.

    Remarks

    This property is not applicable for series axes.

    See Also

  • position

    .position( value:ig.excel.AxisPosition );
    Return Type:
    ig.excel.AxisPosition
    Return Type Description:
    Returns a AxisPosition.

    Sets an AxisPosition value which determines the placement of the axis as relative to the chart space.

    • value
    • Type:ig.excel.AxisPosition

    Remarks

    This property is not applicable for series axes.

    See Also

  • reversePlotOrder

    .reversePlotOrder( );

    True if Excel plots data points from last to first.

  • reversePlotOrder

    .reversePlotOrder( value:boolean );

    True if Excel plots data points from last to first.

    • value
    • Type:boolean

  • scaleType

    .scaleType( );
    Return Type:
    ig.excel.ScaleType
    Return Type Description:
    Returns a ScaleType.

    Returns a value indicating whether the axis scale is linear or logarithmic.

    Remarks

    This property is only applicable for value axes.

    Logarithmic scaling is not supported for axes which are associated with a series that contains negative values.

    See Also

  • scaleType

    .scaleType( value:ig.excel.ScaleType );
    Return Type:
    ig.excel.ScaleType
    Return Type Description:
    Returns a ScaleType.

    Sets a value indicating whether the axis scale is linear or logarithmic.

    • value
    • Type:ig.excel.ScaleType

    Remarks

    This property is only applicable for value axes.

    Logarithmic scaling is not supported for axes which are associated with a series that contains negative values.

    See Also

  • setMajorMinorUnit

    .setMajorMinorUnit( majorUnit:number, minorUnit:number );

    Sets the values of the Axis.majorUnit and Axis.minorUnit properties.

    Remarks

    The value of the majorUnit parameter must exceed the value of the minorUnit parameter or an exception is thrown.

    Typically the value of majorUnit is an exact multiple of minorUnit; for example, for 5 minor units per major unit, set majorUnit to 1 and minorUnit to .2.

    See Also

  • sheet
    Inherited

    .sheet( );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    Returns a Sheet.

    Gets the owning sheet (read-only)

    See Also

  • tickLabelPosition

    .tickLabelPosition( );
    Return Type:
    ig.excel.TickLabelPosition
    Return Type Description:
    Returns a TickLabelPosition.

    Describes the position of tick-mark labels on the specified axis.

    See Also

  • tickLabelPosition

    .tickLabelPosition( value:ig.excel.TickLabelPosition );
    Return Type:
    ig.excel.TickLabelPosition
    Return Type Description:
    Returns a TickLabelPosition.

    Describes the position of tick-mark labels on the specified axis.

    • value
    • Type:ig.excel.TickLabelPosition

    See Also

  • tickLabels

    .tickLabels( );
    Return Type:
    ig.excel.TickLabels
    Return Type Description:
    Returns a TickLabels.

    Returns a TickLabels object that represents the tick-mark labels for the specified axis. Read-only.

    See Also

  • tickLabelSpacing

    .tickLabelSpacing( );

    Returns the number of categories or series between tick-mark labels. Applies only to category and series axes. Can be a value from 1 through 31999.

  • tickLabelSpacing

    .tickLabelSpacing( value:number );

    Sets the number of categories or series between tick-mark labels. Applies only to category and series axes. Can be a value from 1 through 31999.

    • value
    • Type:number

  • tickLabelSpacingIsAuto

    .tickLabelSpacingIsAuto( );

    Returns whether or not the tick label spacing is automatic.

  • tickLabelSpacingIsAuto

    .tickLabelSpacingIsAuto( value:boolean );

    Sets whether or not the tick label spacing is automatic.

    • value
    • Type:boolean

  • tickLines

    .tickLines( );
    Return Type:
    ig.excel.ChartTickLines
    Return Type Description:
    Returns a ChartTickLines.

    Determines the appearance of the tick lines.

    See Also

  • tickLines

    .tickLines( value:ig.excel.ChartTickLines );
    Return Type:
    ig.excel.ChartTickLines
    Return Type Description:
    Returns a ChartTickLines.

    Determines the appearance of the tick lines.

    • value
    • Type:ig.excel.ChartTickLines

    See Also

  • tickMarkSpacing

    .tickMarkSpacing( );

    Returns the number of categories or series between tick marks. Applies only to category and series axes. Can be a value from 1 through 31999.

  • tickMarkSpacing

    .tickMarkSpacing( value:number );

    Sets the number of categories or series between tick marks. Applies only to category and series axes. Can be a value from 1 through 31999.

    • value
    • Type:number

  • type

    .type( );
    Return Type:
    ig.excel.AxisType
    Return Type Description:
    Returns a AxisType.

    Returns the type of the axis (read-only)

    See Also

  • visible

    .visible( );

    Returns whether or not the axis is visible.

  • visible

    .visible( value:boolean );

    Sets whether or not the axis is visible.

    • value
    • Type:boolean

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Gets the owning workbook (read-only)

    See Also

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Gets the owning worksheet (read-only)

    See Also

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.