SpreadJS 13
GC.Spread.Sheets.Charts Namespace / Chart type / axes Method
The chart axes of the chart.
The primary category axis of the chart.
The primary value axis of the chart.
The secondary category axis of the chart.
The secondary value axis of the chart. The primaryCategory, primaryValue, secondaryCategory and secondaryValue have same type.
Indicates if the specified axis should be shown.
The tick label position.
The line style of the primary category axis.
The line color of the primary category axis.
The transparency of the chart primary category axis line color.
The line width of the primary category axis.
The style of the primary category axis.
The color of the primary category axis.
The transparency of the chart primary category axis color.
The font family of the primary category axis.
The font size of the primary category axis, its unit is pixel.
The major tick position of the primary category axis.
The minor tick position of the primary category axis.
The base unit scale of the date primary category axis.
The major unit of the primary category axis.
The major unit scale of the date primary category axis.
The minor unit of the primary category axis.
The minor unit scale of the date primary category axis.
The minimum value of the related axis. (for value / date axis only)
The maximum value of the related axis. (for value / date axis only)
The format of the primary category axis.
The title of the primary category axis.
The title text of the primary category axis.
The title color of the primary category axis.
The transparency of the primary category axis color.
The title font family of the primary category axis.
The title font size of the primary category axis, its unit is pixel.
The major grid line of the primary category axis.
The minor grid line of the primary category axis.
The label angle of the primary category axis.
The scaling informations of the primary category axis.
The logarithmic scaling base value of the primary category axis.
The display unit informations of the primary category axis.
The built-in display unit string or custom number display unit of the primary category axis.
The display unit label visible of the primary category axis.
The display unit label style of the primary category axis.
The display unit label text color of the primary category axis.
The display unit label text transparency of the primary category axis color.
The display unit label text font family of the primary category axis.
The display unit label text font size of the primary category axis, its unit is pixel.
The color of the major grid line.
The visibility of the major grid line.
The width of the major grid line.
The transparency of the major grid line color.
In This Topic
    axes Method
    In This Topic
    Gets or sets the chart axes of the chart.
    Syntax
    var instance = new GC.Spread.Sheets.Charts.Chart(sheet, name, chartType, x, y, width, height, dataRange, dataOrientation);
    var returnValue; // Type: any
    returnValue = instance.axes(value,
                                value.primaryCategory,
                                value.primaryValue,
                                value.secondaryCategory,
                                value.secondaryValue,
                                value.primaryCategory.visible,
                                value.primaryCategory.tickLabelPosition,
                                value.primaryCategory.lineStyle,
                                value.primaryCategory.lineStyle.color,
                                value.primaryCategory.lineStyle.transparency,
                                value.primaryCategory.lineStyle.width,
                                value.primaryCategory.style,
                                value.primaryCategory.style.color,
                                value.primaryCategory.style.transparency,
                                value.primaryCategory.style.fontFamily,
                                value.primaryCategory.style.fontSize,
                                value.primaryCategory.majorTickPosition,
                                value.primaryCategory.minorTickPosition,
                                value.primaryCategory.baseUnit,
                                value.primaryCategory.majorUnit,
                                value.primaryCategory.majorUnitScale,
                                value.primaryCategory.minorUnit,
                                value.primaryCategory.minorUnitScale,
                                value.primaryCategory.min,
                                value.primaryCategory.max,
                                value.primaryCategory.format,
                                value.primaryCategory.title,
                                value.primaryCategory.title.text,
                                value.primaryCategory.title.color,
                                value.primaryCategory.title.transparency,
                                value.primaryCategory.title.fontFamily,
                                value.primaryCategory.title.fontSize,
                                value.primaryCategory.majorGridLine,
                                value.primaryCategory.minorGridLine,
                                value.primaryCategory.labelAngle,
                                value.primaryCategory.scaling,
                                value.primaryCategory.scaling.logBase,
                                value.primaryCategory.displayUnit,
                                value.primaryCategory.displayUnit.unit,
                                value.primaryCategory.displayUnit.visible,
                                value.primaryCategory.displayUnit.style,
                                value.primaryCategory.displayUnit.style.color,
                                value.primaryCategory.displayUnit.style.transparency,
                                value.primaryCategory.displayUnit.style.fontFamily,
                                value.primaryCategory.displayUnit.style.fontSize,
                                value.primaryCategory.majorGridLine.color,
                                value.primaryCategory.majorGridLine.visible,
                                value.primaryCategory.majorGridLine.width,
                                value.primaryCategory.majorGridLine.transparency);
    function axes( 
       value : Object,
       value.primaryCategory : Object,
       value.primaryValue : Object,
       value.secondaryCategory : Object,
       value.secondaryValue : Object,
       value.primaryCategory.visible : boolean,
       value.primaryCategory.tickLabelPosition : TickLabelPosition,
       value.primaryCategory.lineStyle : Object,
       value.primaryCategory.lineStyle.color : string,
       value.primaryCategory.lineStyle.transparency : number,
       value.primaryCategory.lineStyle.width : number,
       value.primaryCategory.style : Object,
       value.primaryCategory.style.color : string,
       value.primaryCategory.style.transparency : number,
       value.primaryCategory.style.fontFamily : string,
       value.primaryCategory.style.fontSize : number,
       value.primaryCategory.majorTickPosition : TickMark,
       value.primaryCategory.minorTickPosition : TickMark,
       value.primaryCategory.baseUnit : GC.Spread.Sheets.Charts.TimeUnit,
       value.primaryCategory.majorUnit : number,
       value.primaryCategory.majorUnitScale : GC.Spread.Sheets.Charts.TimeUnit,
       value.primaryCategory.minorUnit : number,
       value.primaryCategory.minorUnitScale : GC.Spread.Sheets.Charts.TimeUnit,
       value.primaryCategory.min : undefined,
       value.primaryCategory.max : undefined,
       value.primaryCategory.format : string,
       value.primaryCategory.title : Object,
       value.primaryCategory.title.text : string,
       value.primaryCategory.title.color : string,
       value.primaryCategory.title.transparency : number,
       value.primaryCategory.title.fontFamily : string,
       value.primaryCategory.title.fontSize : number,
       value.primaryCategory.majorGridLine : Object,
       value.primaryCategory.minorGridLine : Object,
       value.primaryCategory.labelAngle : number,
       value.primaryCategory.scaling : Object,
       value.primaryCategory.scaling.logBase : number,
       value.primaryCategory.displayUnit : Object,
       value.primaryCategory.displayUnit.unit : undefined,
       value.primaryCategory.displayUnit.visible : boolean,
       value.primaryCategory.displayUnit.style : Object,
       value.primaryCategory.displayUnit.style.color : string,
       value.primaryCategory.displayUnit.style.transparency : number,
       value.primaryCategory.displayUnit.style.fontFamily : string,
       value.primaryCategory.displayUnit.style.fontSize : number,
       value.primaryCategory.majorGridLine.color : string,
       value.primaryCategory.majorGridLine.visible : boolean,
       value.primaryCategory.majorGridLine.width : number,
       value.primaryCategory.majorGridLine.transparency : number
    ) : any;

    Parameters

    value
    The chart axes of the chart.
    value.primaryCategory
    The primary category axis of the chart.
    value.primaryValue
    The primary value axis of the chart.
    value.secondaryCategory
    The secondary category axis of the chart.
    value.secondaryValue
    The secondary value axis of the chart. The primaryCategory, primaryValue, secondaryCategory and secondaryValue have same type.
    value.primaryCategory.visible
    Indicates if the specified axis should be shown.
    value.primaryCategory.tickLabelPosition
    The tick label position.
    value.primaryCategory.lineStyle
    The line style of the primary category axis.
    value.primaryCategory.lineStyle.color
    The line color of the primary category axis.
    value.primaryCategory.lineStyle.transparency
    The transparency of the chart primary category axis line color.
    value.primaryCategory.lineStyle.width
    The line width of the primary category axis.
    value.primaryCategory.style
    The style of the primary category axis.
    value.primaryCategory.style.color
    The color of the primary category axis.
    value.primaryCategory.style.transparency
    The transparency of the chart primary category axis color.
    value.primaryCategory.style.fontFamily
    The font family of the primary category axis.
    value.primaryCategory.style.fontSize
    The font size of the primary category axis, its unit is pixel.
    value.primaryCategory.majorTickPosition
    The major tick position of the primary category axis.
    value.primaryCategory.minorTickPosition
    The minor tick position of the primary category axis.
    value.primaryCategory.baseUnit
    The base unit scale of the date primary category axis.
    value.primaryCategory.majorUnit
    The major unit of the primary category axis.
    value.primaryCategory.majorUnitScale
    The major unit scale of the date primary category axis.
    value.primaryCategory.minorUnit
    The minor unit of the primary category axis.
    value.primaryCategory.minorUnitScale
    The minor unit scale of the date primary category axis.
    value.primaryCategory.min
    The minimum value of the related axis. (for value / date axis only)
    value.primaryCategory.max
    The maximum value of the related axis. (for value / date axis only)
    value.primaryCategory.format
    The format of the primary category axis.
    value.primaryCategory.title
    The title of the primary category axis.
    value.primaryCategory.title.text
    The title text of the primary category axis.
    value.primaryCategory.title.color
    The title color of the primary category axis.
    value.primaryCategory.title.transparency
    The transparency of the primary category axis color.
    value.primaryCategory.title.fontFamily
    The title font family of the primary category axis.
    value.primaryCategory.title.fontSize
    The title font size of the primary category axis, its unit is pixel.
    value.primaryCategory.majorGridLine
    The major grid line of the primary category axis.
    value.primaryCategory.minorGridLine
    The minor grid line of the primary category axis.
    value.primaryCategory.labelAngle
    The label angle of the primary category axis.
    value.primaryCategory.scaling
    The scaling informations of the primary category axis.
    value.primaryCategory.scaling.logBase
    The logarithmic scaling base value of the primary category axis.
    value.primaryCategory.displayUnit
    The display unit informations of the primary category axis.
    value.primaryCategory.displayUnit.unit
    The built-in display unit string or custom number display unit of the primary category axis.
    value.primaryCategory.displayUnit.visible
    The display unit label visible of the primary category axis.
    value.primaryCategory.displayUnit.style
    The display unit label style of the primary category axis.
    value.primaryCategory.displayUnit.style.color
    The display unit label text color of the primary category axis.
    value.primaryCategory.displayUnit.style.transparency
    The display unit label text transparency of the primary category axis color.
    value.primaryCategory.displayUnit.style.fontFamily
    The display unit label text font family of the primary category axis.
    value.primaryCategory.displayUnit.style.fontSize
    The display unit label text font size of the primary category axis, its unit is pixel.
    value.primaryCategory.majorGridLine.color
    The color of the major grid line.
    value.primaryCategory.majorGridLine.visible
    The visibility of the major grid line.
    value.primaryCategory.majorGridLine.width
    The width of the major grid line.
    value.primaryCategory.majorGridLine.transparency
    The transparency of the major grid line color.

    Return Value

    If no value is set, returns the chart axes of the chart; otherwise, returns the chart. The majorGridLine and minorGridLine have same type.If no value is set, returns the chart axes of the chart; otherwise, returns the chart.
    Remarks

    The following table lists all the other parameters that can be used while getting or setting the chart axes.

    Parameter Type Description
    value.primaryCategory object The primary category axis of the chart.
    value.primaryValue object The primary value axis of the chart.
    value.secondaryCategory object The secondary category axis of the chart.The secondary category axis of the chart.
    value.secondaryValue object The secondary value axis of the chart.
    value.primaryCategory.visible boolean Indicates if the specified axis should be shown.
    value.primaryCategory.tickLabelPosition The tick label position.
    value.primaryCategory.lineStyle object The line style of the primary category axis.
    value.primaryCategory.lineStyle.color string The line color of the primary category axis.
    value.primaryCategory.lineStyle.width number The line width of the primary category axis.
    value.primaryCategory.style object The style of the primary category axis.
    value.primaryCategory.style.color string The color of the primary category axis.
    value.primaryCategory.style.fontFamily string The font family of the primary category axis.
    value.primaryCategory.style.fontSize number The font size of the primary category axis, its unit is pixel.
    value.primaryCategory.majorTickPosition - The major tick position of the primary category axis.
    value.primaryCategory.minorTickPosition - The minor tick position of the primary category axis.
    value.primaryCategory.min number The minimum value of the related axis. (for value and date axis only)
    value.primaryCategory.max number The maximum value of the related axis. (for value and date axis only)
    value.primaryCategory.majorUnit number The major unit of the primary category axis.
    value.primaryCategory.minorUnit number The minor unit of the primary category axis.
    value.primaryCategory.format string The format of the primary category axis.
    value.primaryCategory.title object The title of the primary category axis.
    value.primaryCategory.title.text string The title text of the primary category axis.
    value.primaryCategory.title.color string The title color of the primary category axis.
    value.primaryCategory.title.fontFamily string The title font family of the primary category axis.
    value.primaryCategory.title.fontSize number The title font size of the primary category axis, its unit is pixel.
    value.primaryCategory.majorGridLine object The major grid line of the primary category axis.
    value.primaryCategory.minorGridLine object The minor grid line of the primary category axis.
    value.primaryCategory.majorGridLine.color string The color of the major grid line.
    value.primaryCategory.majorGridLine.visible boolean The visibility of the major grid line.
    value.primaryCategory.majorGridLine.width number The width of the major grid line.

    See Also

    Reference

    Chart type