Excel.ChartLegend class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Stellt die Formatierung für eine Diagrammlegende dar, einschließlich Füllung und Schriftartformatierung.

readonly format: Excel.ChartLegendFormat;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt an, ob sich die Diagrammlegende mit dem Hauptteil des Diagramms überlappen soll.

overlay: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt die Position der Legende im Diagramm an. Weitere Informationen findest du hier Excel.ChartLegendPosition .

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

function createChart(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let dataRange = sheet.getRange("A3:E7");
    let chart = sheet.charts.add("ColumnStacked", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Sales";
    chart.setPosition("A10", "H33");
    chart.legend.position = "Right";
    chart.legend.format.fill.setSolidColor("white");
    chart.dataLabels.format.font.size = 15;
    chart.dataLabels.format.font.color = "black";
}

Gibt an, ob die Diagrammlegende sichtbar ist.

visible: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

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

    let chart = sheet.charts.getItemAt(0);
    chart.legend.visible = true;

    // Format the legend font.
    const font: Excel.ChartFont = chart.legend.format.font;
    font.bold = true;
    font.color = "red";
    font.italic = true;
    font.size = 15;
    font.name = "Calibri";
    font.underline = "Single";

    await context.sync();
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Beispiele

// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const legend = chart.legend;
    legend.load('position');
    await context.sync();

    console.log(legend.position);
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.ChartLegend): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.ChartLegend Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ChartLegendData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.ChartLegendData;

Gibt zurück