Excel.ChartAxisTitle class

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

context: RequestContext;

プロパティ値

グラフ軸のタイトルの書式設定を指定します。

readonly format: Excel.ChartAxisTitleFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

軸のタイトルを指定します。

text: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

textOrientation: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.12 ]

例

await Excel.run(async (context) => {
  // Get a chart named "Sales Chart" from the "Sample" worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  let chart = sheet.charts.getItem("Sales Chart");

  // Set the value axis title to "Profits".
  chart.axes.valueAxis.title.text = "Profits";

  /* Set the value axis text orientation to 0.
    For charts with a y-axis, this makes the label on the y-axis horizontal, 
    instead of the default look of rotated-vertically.
    */ 
  chart.axes.valueAxis.title.textOrientation = 0;
  await context.sync();
});

軸のタイトルが表示されるかどうかを指定します。

visible: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.axes.valueAxis.title.text = "Values";
    await context.sync();
    
    console.log("Axis Title Added ");
});

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

set(properties: Excel.ChartAxisTitle): void;

パラメーター

戻り値

A1 スタイルの表記法を使用するグラフの軸タイトルの数式を表す文字列値。

setFormula(formula: string): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartAxisTitle オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartAxisTitleData として型指定) を返します。

toJSON(): Excel.Interfaces.ChartAxisTitleData;

戻り値