Excel. Chart Axis class

axisGroup

指定した軸のグループを指定します。詳細は「Excel.ChartAxisGroup」をご覧ください。

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

プロパティ値

Excel.ChartAxisGroup | "Primary" | "Secondary"

注釈

baseTimeUnit

指定したカテゴリ軸の基本単位を指定します。

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

注釈

categoryType

カテゴリ軸の種類を指定します。

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

プロパティ値

Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"

注釈

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

customDisplayUnit

カスタム軸の表示単位の値を指定します。このプロパティを設定するには、 SetCustomDisplayUnit(double) メソッドを使用してください。

readonly customDisplayUnit: number;

プロパティ値

number

注釈

displayUnit

軸の表示単位を表します。詳細は「Excel.ChartAxisDisplayUnit」をご覧ください。

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

プロパティ値

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    let categoryAxis = chart.axes.categoryAxis;
    let valueAxis = chart.axes.valueAxis;

    // Load to get display unit.
    valueAxis.load("displayUnit");

    await context.sync();

    console.log("The vertical axis display unit is: " + valueAxis.displayUnit);
});

format

線とフォントの書式設定を含むグラフオブジェクトの書式設定を表します。

readonly format: Excel.ChartAxisFormat;

プロパティ値

Excel.ChartAxisFormat

注釈

height

グラフ軸の高さをポイント単位で指定します。軸が表示されていない場合は、 null を返します。

readonly height: number;

プロパティ値

number

注釈

isBetweenCategories

値軸がカテゴリ軸とカテゴリの間で交差するかどうかを指定します。

isBetweenCategories: boolean;

プロパティ値

boolean

注釈

left

軸の左端からグラフ領域の左側までの距離をポイント単位で指定します。軸が表示されていない場合は、 null を返します。

readonly left: number;

プロパティ値

number

注釈

logBase

対数スケールを使用する場合の対数の底を指定します。

logBase: number;

プロパティ値

number

注釈

majorGridlines

指定した軸の目盛線を表すオブジェクトを返します。

readonly majorGridlines: Excel.ChartGridlines;

プロパティ値

Excel.ChartGridlines

注釈

majorTickMark

指定した軸の目盛りの種類を指定します。詳細は「Excel.ChartAxisTickMark」をご覧ください。

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

プロパティ値

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

注釈

majorTimeUnitScale

categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸のメジャー単位スケール値を指定します。

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

注釈

majorUnit

2 つの大きい目盛の間隔を表します。数値の値または空の文字列を設定できます。戻り値は常に数値です。

majorUnit: any;

プロパティ値

any

注釈

maximum

数値軸の最大値を表します。数値の値または空の文字列を設定できます (軸の値が自動の場合)。戻り値は常に数値です。

maximum: any;

プロパティ値

any

注釈

minimum

数値軸の最小値を表します。数値の値または空の文字列を設定できます (軸の値が自動の場合)。戻り値は常に数値です。

minimum: any;

プロパティ値

any

注釈

minorGridlines

指定した軸の補助目盛線を表すオブジェクトを返します。

readonly minorGridlines: Excel.ChartGridlines;

プロパティ値

Excel.ChartGridlines

注釈

minorTickMark

指定した軸の補助目盛りの種類を指定します。詳細は「Excel.ChartAxisTickMark」をご覧ください。

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

プロパティ値

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

注釈

minorTimeUnitScale

categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸の小単位スケール値を指定します。

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

注釈

minorUnit

2 つの小さい目盛の間隔を表します。数値の値または空の文字列を設定できます (軸の値が自動の場合)。戻り値は常に数値です。

minorUnit: any;

プロパティ値

any

注釈

multiLevel

軸がマルチレベルかどうかを指定します。

multiLevel: boolean;

プロパティ値

boolean

注釈

numberFormat

軸目盛ラベルの書式コードを指定します。

numberFormat: string;

プロパティ値

string

注釈

offset

ラベルのレベル間の距離と、最初のレベルと軸線の間の距離を指定します。値は 0 から 1000 の範囲内でなければなりません。

offset: number;

プロパティ値

number

注釈

position

他の軸が交差する指定した軸の位置を指定します。詳細は「Excel.ChartAxisPosition」をご覧ください。

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

プロパティ値

Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"

注釈

positionAt

他の軸が交差する軸の位置を指定します。このプロパティを設定するには、 SetPositionAt(double) メソッドを使用する必要があります。

readonly positionAt: number;

プロパティ値

number

注釈

reversePlotOrder

Excel でデータポイントを最後から最初にプロットするかどうかを指定します。

reversePlotOrder: boolean;

プロパティ値

boolean

注釈

scaleType

値軸スケールの種類を指定します。詳細は「Excel.ChartAxisScaleType」をご覧ください。

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

プロパティ値

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

注釈

showDisplayUnitLabel

軸の表示単位ラベルを表示するかどうかを指定します。

showDisplayUnitLabel: boolean;

プロパティ値

boolean

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);
    let axis = chart.axes.valueAxis;

    // Remove display unit.
    axis.showDisplayUnitLabel = false;

    await context.sync();
});

textOrientation

グラフ軸目盛ラベルのテキストの向きを示す角度を指定します。値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

textOrientation: any;

プロパティ値

any

注釈

tickLabelPosition

指定された軸の目盛ラベルの位置を指定します。詳細は「Excel.ChartAxisTickLabelPosition」をご覧ください。

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

プロパティ値

Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"

注釈

tickLabelSpacing

目盛ラベル間のカテゴリまたは系列の数を指定します。 1 から 31999 の範囲内で値を設定できます。自動的に設定する場合は、空の文字列にします。戻り値は常に数値です。

tickLabelSpacing: any;

プロパティ値

any

注釈

tickMarkSpacing

目盛りの間のカテゴリまたは系列の数を指定します。

tickMarkSpacing: number;

プロパティ値

number

注釈

title

軸タイトルを表します。

readonly title: Excel.ChartAxisTitle;

プロパティ値

Excel.ChartAxisTitle

注釈

top

軸の上端からグラフ領域の上端までの距離をポイント単位で指定します。軸が表示されていない場合は、 null を返します。

readonly top: number;

プロパティ値

number

注釈

type

軸の種類を指定します。詳細は「Excel.ChartAxisType」をご覧ください。

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

プロパティ値

Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"

注釈

visible

軸が表示されるかどうかを指定します。

visible: boolean;

プロパティ値

boolean

注釈

width

グラフ軸の幅をポイント単位で指定します。軸が表示されていない場合は、 null を返します。

readonly width: number;

プロパティ値

number

注釈

メソッドの詳細

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

パラメーター

options: Excel.Interfaces.ChartAxisLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.ChartAxis

load(propertyNames)

load(propertyNames?: string | string[]): Excel.ChartAxis;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.ChartAxis

例

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartAxis;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.ChartAxis

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Excel.Interfaces.ChartAxisUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ChartAxis): void;

パラメーター

properties: Excel.ChartAxis

戻り値

void

setCategoryNames(sourceData)

指定した軸のすべてのカテゴリ名を設定します。

setCategoryNames(sourceData: Range): void;

パラメーター

sourceData: Excel.Range

ソースデータに対応する Range オブジェクト。

戻り値

void

注釈

setCustomDisplayUnit(value)

軸の表示単位をカスタム値に設定します。

setCustomDisplayUnit(value: number): void;

パラメーター

value: number

表示単位のカスタム値。

戻り値

void

注釈

setPositionAt(value)

他の軸が交差する指定した軸の位置を設定します。

setPositionAt(value: number): void;

パラメーター

value: number

交差点のカスタム値。

戻り値

void

注釈