Excel.ChartTitle class

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

context: RequestContext;

プロパティ値

塗りつぶしとフォントの書式設定を含む、グラフ タイトルの書式設定を表します。

readonly format: Excel.ChartTitleFormat;

プロパティ値

注釈

API セット: ExcelApi 1.1

グラフ タイトルの高さ (ポイント数) を返します。 グラフ タイトルが表示されない場合は、値が null されます。

readonly height: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルの水平方向の配置を指定します。

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

プロパティ値

注釈

API セット: ExcelApi 1.7

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

left: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルがグラフに重ねて表示されるかどうかを指定します。

overlay: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

グラフ タイトルの位置を表します。 詳細は「Excel.ChartTitlePosition」をご覧ください。

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルに影があるかどうかを判断するブール値を表します。

showShadow: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフのタイトル テキストを指定します。

text: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

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

textOrientation: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

例

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
});

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

top: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルの垂直方向の配置を指定します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルを表示するかどうかを指定します。

visible: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

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

readonly width: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

グラフ タイトルの部分文字列を取得します。 改行 '\n' は 1 文字カウントします。

getSubstring(start: number, length: number): Excel.ChartFormatString;

パラメーター

返品

注釈

API セット: ExcelApi 1.7

例

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

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

    // Get first seven characters of the title and color them green.
    chart.title.getSubstring(0, 7).font.color = "Yellow";
    await context.sync();
});

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

load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle;

パラメーター

返品

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

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

パラメーター

返品

例

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    chart.title.text= "My Chart"; 
    chart.title.visible=true;
    chart.title.overlay=true;
    
    await context.sync();
    console.log("Char Title Changed");
});

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Excel.ChartTitle): void;

パラメーター

返品

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

setFormula(formula: string): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.7

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

toJSON(): Excel.Interfaces.ChartTitleData;

返品