Excel.ChartTitle class
Ein Diagrammtitelobjekt eines Diagramms.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| format | Stellt die Formatierung für einen Diagrammtitel dar, einschließlich Füllung und Schriftartformatierung. |
| height | Gibt die Höhe des Diagrammtitels in Punkten zurück. Der Wert ist |
| horizontal |
Gibt die horizontale Ausrichtung für den Diagrammtitel an. |
| left | Gibt den Abstand in Punkt vom linken Rand des Diagrammtitels zum linken Rand des Diagrammbereichs an. Der Wert ist |
| overlay | Gibt an, ob der Diagrammtitel das Diagramm überlagert. |
| position | Gibt die Position des Diagrammtitels an. Weitere Informationen finden Sie unter |
| show |
Stellt einen booleschen Wert dar, der bestimmt, ob der Diagrammtitel über eine Schattierung verfügt. |
| text | Gibt den Titeltext des Diagramms an. |
| text |
Gibt den Winkel an, an dem der Text für den Diagrammtitel ausgerichtet ist. Der Wert sollte entweder eine ganze Zahl von -90 bis 90 oder die ganze Zahl 180 für vertikal ausgerichteten Text sein. |
| top | Gibt den Abstand in Punkt vom oberen Rand des Diagrammtitels bis zum oberen Rand des Diagrammbereichs an. Der Wert ist |
| vertical |
Gibt die vertikale Ausrichtung des Diagrammtitels an. Weitere Informationen finden Sie unter |
| visible | Gibt an, ob der Diagrammtitel sichtbar ist. |
| width | Gibt die Breite des Diagrammtitels in Punkt an. Der Wert ist |
Methoden
| get |
Ruft die Teilzeichenfolge eines Diagrammtitels ab. Zeilenumbruch '\n' zählt ein Zeichen. |
| 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. |
| set |
Legt einen Zeichenfolgenwert fest, der die Formel des Diagrammtitels unter Verwendung der A1-Schreibweise angibt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
format
Stellt die Formatierung für einen Diagrammtitel dar, einschließlich Füllung und Schriftartformatierung.
readonly format: Excel.ChartTitleFormat;Eigenschaftswert
Hinweise
height
Gibt die Höhe des Diagrammtitels in Punkten zurück. Der Wert ist null , wenn der Diagrammtitel nicht sichtbar ist.
readonly height: number;Eigenschaftswert
number
Hinweise
horizontalAlignment
Gibt die horizontale Ausrichtung für den Diagrammtitel an.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Eigenschaftswert
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Hinweise
left
Gibt den Abstand in Punkt vom linken Rand des Diagrammtitels zum linken Rand des Diagrammbereichs an. Der Wert ist null , wenn der Diagrammtitel nicht sichtbar ist.
left: number;Eigenschaftswert
number
Hinweise
overlay
Gibt an, ob der Diagrammtitel das Diagramm überlagert.
overlay: boolean;Eigenschaftswert
boolean
Hinweise
position
Gibt die Position des Diagrammtitels an. Weitere Informationen finden Sie unter Excel.ChartTitlePosition .
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";Eigenschaftswert
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
Hinweise
showShadow
Stellt einen booleschen Wert dar, der bestimmt, ob der Diagrammtitel über eine Schattierung verfügt.
showShadow: boolean;Eigenschaftswert
boolean
Hinweise
text
Gibt den Titeltext des Diagramms an.
text: string;Eigenschaftswert
string
Hinweise
textOrientation
Gibt den Winkel an, an dem der Text für den Diagrammtitel ausgerichtet ist. Der Wert sollte entweder eine ganze Zahl von -90 bis 90 oder die ganze Zahl 180 für vertikal ausgerichteten Text sein.
textOrientation: number;Eigenschaftswert
number
Hinweise
Beispiele
// 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();
});
top
Gibt den Abstand in Punkt vom oberen Rand des Diagrammtitels bis zum oberen Rand des Diagrammbereichs an. Der Wert ist null , wenn der Diagrammtitel nicht sichtbar ist.
top: number;Eigenschaftswert
number
Hinweise
verticalAlignment
Gibt die vertikale Ausrichtung des Diagrammtitels an. Weitere Informationen finden Sie unter Excel.ChartTextVerticalAlignment .
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Eigenschaftswert
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Hinweise
visible
Gibt an, ob der Diagrammtitel sichtbar ist.
visible: boolean;Eigenschaftswert
boolean
Hinweise
width
Gibt die Breite des Diagrammtitels in Punkt an. Der Wert ist null , wenn der Diagrammtitel nicht sichtbar ist.
readonly width: number;Eigenschaftswert
number
Hinweise
Details zur Methode
getSubstring(start, length)
Ruft die Teilzeichenfolge eines Diagrammtitels ab. Zeilenumbruch '\n' zählt ein Zeichen.
getSubstring(start: number, length: number): Excel.ChartFormatString;Parameter
- start
-
number
Startposition der abzurufenden Teilzeichenfolge. Nullindiziert.
- length
-
number
Länge der abzurufenden Teilzeichenfolge.
Gibt zurück
Hinweise
Beispiele
// 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();
});
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.ChartTitleLoadOptions): Excel.ChartTitle;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.ChartTitle;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
// 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");
});
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.ChartTitle;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen 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.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.ChartTitleUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.ChartTitle): void;Parameter
- properties
- Excel.ChartTitle
Gibt zurück
void
setFormula(formula)
Legt einen Zeichenfolgenwert fest, der die Formel des Diagrammtitels unter Verwendung der A1-Schreibweise angibt.
setFormula(formula: string): void;Parameter
- formula
-
string
Eine Zeichenfolge, die die festzulegende Formel darstellt.
Gibt zurück
void
Hinweise
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 das Objekt übergeben wird.) Während das ursprüngliche Excel.ChartTitle Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ChartTitleData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.ChartTitleData;Gibt zurück
Office Add-ins