Excel.ChartLegend class
Stellt die Legende in einem Diagramm dar.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| format | Stellt die Formatierung für eine Diagrammlegende dar, einschließlich Füllung und Schriftartformatierung. |
| height | Gibt die Höhe der Legende im Diagramm in Punkten an. Wert ist |
| left | Gibt den linken Wert der Legende im Diagramm in Punkten an. Wert ist |
| legend |
Stellt eine Sammlung von LegendEntries in der Legende dar. |
| overlay | Gibt an, ob sich die Diagrammlegende mit dem Hauptteil des Diagramms überlappen soll. |
| position | Gibt die Position der Legende im Diagramm an. Weitere Informationen findest du hier |
| show |
Gibt an, ob die Legende einen Schatten auf dem Diagramm aufweist. |
| top | Gibt den oberen Rand einer Diagrammlegende an. |
| visible | Gibt an, ob die Diagrammlegende sichtbar ist. |
| width | Gibt die Breite der Legende im Diagramm in Punkten an. Wert ist |
Methoden
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | 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) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
format
Stellt die Formatierung für eine Diagrammlegende dar, einschließlich Füllung und Schriftartformatierung.
readonly format: Excel.ChartLegendFormat;Eigenschaftswert
Hinweise
height
Gibt die Höhe der Legende im Diagramm in Punkten an. Wert ist null , wenn die Legende nicht sichtbar ist.
height: number;Eigenschaftswert
number
Hinweise
left
Gibt den linken Wert der Legende im Diagramm in Punkten an. Wert ist null , wenn die Legende nicht sichtbar ist.
left: number;Eigenschaftswert
number
Hinweise
legendEntries
Stellt eine Sammlung von LegendEntries in der Legende dar.
readonly legendEntries: Excel.ChartLegendEntryCollection;Eigenschaftswert
Hinweise
overlay
Gibt an, ob sich die Diagrammlegende mit dem Hauptteil des Diagramms überlappen soll.
overlay: boolean;Eigenschaftswert
boolean
Hinweise
position
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
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
Hinweise
showShadow
Gibt an, ob die Legende einen Schatten auf dem Diagramm aufweist.
showShadow: boolean;Eigenschaftswert
boolean
Hinweise
top
Gibt den oberen Rand einer Diagrammlegende an.
top: number;Eigenschaftswert
number
Hinweise
visible
Gibt an, ob die Diagrammlegende sichtbar ist.
visible: boolean;Eigenschaftswert
boolean
Hinweise
width
Gibt die Breite der Legende im Diagramm in Punkten an. Wert ist null , wenn die Legende nicht sichtbar ist.
width: number;Eigenschaftswert
number
Hinweise
Details zur Methode
load(options)
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
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
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
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);
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
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
- properties
- Excel.Interfaces.ChartLegendUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.ChartLegend): void;Parameter
- properties
- Excel.ChartLegend
Gibt zurück
void
toJSON()
Ü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;