ExcelScript.ChartTitle interface

Colis:

ExcelScript

Représente un objet de titre pour un graphique.

Remarques

Exemples

/**
 * This sample accesses and customizes the chart title.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Customize the title.
  const title = chart.getTitle();
  title.setText("Quarterly Sales by Product");
  title.setVisible(true);
}

Méthode

getFormat()	Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police.
getHeight()	Représente la hauteur, exprimée en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.
getHorizontalAlignment()	Spécifie l’alignement horizontal du titre du graphique.
getLeft()	Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.
getOverlay()	Spécifie si le titre du graphique va superposer le graphique.
getPosition()	Représente la position du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTitlePosition .
getShowShadow()	Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.
getSubstring(start, length)	Obtient la sous-chaîne d’un titre de graphique. Le saut de ligne '\n' compte un caractère.
getText()	Spécifie le texte du titre du graphique.
getTextOrientation()	Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.
getTop()	Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.
getVerticalAlignment()	Spécifie l’alignement vertical du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment .
getVisible()	Spécifie si le titre du graphique est visible.
getWidth()	Spécifie la largeur, en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.
setFormula(formula)	Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1.
setHorizontalAlignment(horizontalAlignment)	Spécifie l’alignement horizontal du titre du graphique.
setLeft(left)	Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.
setOverlay(overlay)	Spécifie si le titre du graphique va superposer le graphique.
setPosition(position)	Représente la position du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTitlePosition .
setShowShadow(showShadow)	Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.
setText(text)	Spécifie le texte du titre du graphique.
setTextOrientation(textOrientation)	Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.
setTop(top)	Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.
setVerticalAlignment(verticalAlignment)	Spécifie l’alignement vertical du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment .
setVisible(visible)	Spécifie si le titre du graphique est visible.

Détails de la méthode

getFormat()

Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police.

getFormat(): ChartTitleFormat;

Retourne

ExcelScript.ChartTitleFormat

getHeight()

Représente la hauteur, exprimée en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.

getHeight(): number;

Retourne

number

getHorizontalAlignment()

Spécifie l’alignement horizontal du titre du graphique.

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Retourne

ExcelScript.ChartTextHorizontalAlignment

getLeft()

Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

getLeft(): number;

Retourne

number

getOverlay()

Spécifie si le titre du graphique va superposer le graphique.

getOverlay(): boolean;

Retourne

boolean

getPosition()

Représente la position du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTitlePosition .

getPosition(): ChartTitlePosition;

Retourne

ExcelScript.ChartTitlePosition

getShowShadow()

Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.

getShowShadow(): boolean;

Retourne

boolean

getSubstring(start, length)

Obtient la sous-chaîne d’un titre de graphique. Le saut de ligne '\n' compte un caractère.

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

Paramètres

start

number

Position de début de la sous-chaîne à récupérer. Avec indice zéro.

length

number

Longueur de la sous-chaîne à récupérer.

Retourne

ExcelScript.ChartFormatString

getText()

Spécifie le texte du titre du graphique.

getText(): string;

Retourne

string

getTextOrientation()

Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.

getTextOrientation(): number;

Retourne

number

getTop()

Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

getTop(): number;

Retourne

number

getVerticalAlignment()

Spécifie l’alignement vertical du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment .

getVerticalAlignment(): ChartTextVerticalAlignment;

Retourne

ExcelScript.ChartTextVerticalAlignment

getVisible()

Spécifie si le titre du graphique est visible.

getVisible(): boolean;

Retourne

boolean

getWidth()

Spécifie la largeur, en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.

getWidth(): number;

Retourne

number

setFormula(formula)

Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1.

setFormula(formula: string): void;

Paramètres

formula

string

Chaîne qui représente la formule à définir.

Retourne

void

setHorizontalAlignment(horizontalAlignment)

Spécifie l’alignement horizontal du titre du graphique.

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Paramètres

horizontalAlignment

ExcelScript.ChartTextHorizontalAlignment

Retourne

void

setLeft(left)

Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

setLeft(left: number): void;

Paramètres

left

number

Retourne

void

setOverlay(overlay)

Spécifie si le titre du graphique va superposer le graphique.

setOverlay(overlay: boolean): void;

Paramètres

overlay

boolean

Retourne

void

setPosition(position)

Représente la position du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTitlePosition .

setPosition(position: ChartTitlePosition): void;

Paramètres

position

ExcelScript.ChartTitlePosition

Retourne

void

setShowShadow(showShadow)

Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.

setShowShadow(showShadow: boolean): void;

Paramètres

showShadow

boolean

Retourne

void

setText(text)

Spécifie le texte du titre du graphique.

setText(text: string): void;

Paramètres

text

string

Retourne

void

Exemples

/**
 * This sample sets the chart title text.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the chart title.
  chart.getTitle().setText("Quarterly Sales by Product");
}

setTextOrientation(textOrientation)

Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.

setTextOrientation(textOrientation: number): void;

Paramètres

textOrientation

number

Retourne

void

setTop(top)

Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

setTop(top: number): void;

Paramètres

top

number

Retourne

void

setVerticalAlignment(verticalAlignment)

Spécifie l’alignement vertical du titre du graphique. Pour plus d’informations, consultez ExcelScript.ChartTextVerticalAlignment .

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Paramètres

verticalAlignment

ExcelScript.ChartTextVerticalAlignment

Retourne

void

setVisible(visible)

Spécifie si le titre du graphique est visible.

setVisible(visible: boolean): void;

Paramètres

visible

boolean

Retourne

void