Excel.ChartDataLabels class

データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。

autoText: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.8

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

context: RequestContext;

プロパティ値

塗りつぶしやフォントの書式設定を含むグラフのデータ ラベルの書式を指定します。

readonly format: Excel.ChartDataLabelFormat;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベルの幾何学的形状の種類を指定します。 詳細については、Excel.GeometricShapeTypeを参照してください。 データ ラベルが幾何学的図形ではない場合、値は null です。

geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

プロパティ値

注釈

API セット: ExcelApi 1.19

グラフのデータ ラベルの水平方向の配置を指定します。 詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が 0 の場合にのみ有効です。

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

プロパティ値

注釈

API セット: ExcelApi 1.8

データ ラベルの引出線を表すオブジェクトを取得します。

readonly leaderLines: Excel.ChartLeaderLines;

プロパティ値

注釈

API セット: ExcelApi 1.19

数値の表示形式をセルにリンクするかどうかを指定します。 true の場合、数値の表示形式は、セル内で変更されるとラベルの表示形式が変更されます。

linkNumberFormat: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.9

データ ラベルの書式コードを指定します。

numberFormat: string;

プロパティ値

注釈

API セット: ExcelApi 1.8

データ ラベルの位置を表す値。 詳細は「Excel.ChartDataLabelPosition」をご覧ください。

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

プロパティ値

注釈

API セット: ExcelApi 1.1

グラフのデータ ラベルに使用される区切り文字を表す文字列を設定します。

separator: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ポイントにテール アンカーがアタッチされた吹き出しとしてデータ ラベルを表示するかどうかを指定します。 true の場合、吹き出しは次の値のいずれかになります: "AccentCallout1"、"AccentCallout2"、"BorderCallout1"、"BorderCallout2"、"WedgeRectCallout"、"WedgeRRectCallout"、または "WedgeEllipseCallout"。 詳細については、 GeometricShapeType を参照してください。

readonly showAsStickyCallout: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.19

データ ラベルのバブル サイズを表示するかどうかを指定します。

showBubbleSize: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベル カテゴリ名を表示するかどうかを指定します。

showCategoryName: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベルに引出線を表示するかどうかを指定します。 true 引出線が表示されている場合。それ以外の場合は、 false。

showLeaderLines: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.19

データ ラベルの凡例キーを表示するかどうかを指定します。

showLegendKey: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベルのパーセンテージを表示するかどうかを指定します。

showPercentage: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベル系列名を表示するかどうかを指定します。

showSeriesName: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

データ ラベルの値が表示されるかどうかを指定します。

showValue: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.1

テキストがデータ ラベルの向きになる角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は 180 の整数にする必要があります。

textOrientation: number;

プロパティ値

注釈

API セット: ExcelApi 1.8

グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。

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

プロパティ値

注釈

API セット: ExcelApi 1.8

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

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

パラメーター

返品

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

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

パラメーター

返品

例

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Excel.ChartDataLabels): void;

パラメーター

返品

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

toJSON(): Excel.Interfaces.ChartDataLabelsData;

返品