Excel.ChartTitle class

Referencia

Paquete:: excel

Representa un objeto de título de gráfico de un gráfico.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
format	Representa el formato de un título del gráfico, que incluye el formato de relleno y de fuente.
height	Devuelve el alto, en puntos, del título del gráfico. El valor es `null` si el título del gráfico no está visible.
horizontalAlignment	Especifica la alineación horizontal del título del gráfico.
left	Especifica la distancia, en puntos, desde el borde izquierdo del título del gráfico hasta el borde izquierdo del área del gráfico. El valor es `null` si el título del gráfico no está visible.
overlay	Especifica si el título del gráfico se superpondrá al gráfico.
position	Representa la posición del título del gráfico. Vea `Excel.ChartTitlePosition` para más información.
showShadow	Representa un valor booleano que determina si el título del gráfico tiene una propiedad reemplazada.
text	Especifica el texto del título del gráfico.
textOrientation	Especifica el ángulo al que está orientado el texto para el título del gráfico. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente.
top	Especifica la distancia, en puntos, desde el borde superior del título del gráfico hasta la parte superior del área del gráfico. El valor es `null` si el título del gráfico no está visible.
verticalAlignment	Especifica la alineación vertical del título del gráfico. Vea `Excel.ChartTextVerticalAlignment` para más información.
visible	Especifica si el título del gráfico está visible.
width	Especifica el ancho, en puntos, del título del gráfico. El valor es `null` si el título del gráfico no está visible.

Métodos

getSubstring(start, length)	Obtenga la subcadena de un título de gráfico. El salto de línea '\n' cuenta un carácter.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setFormula(formula)	Establece un valor de cadena que representa la fórmula del título del gráfico con la notación de estilo A1.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de API a `JSON.stringify()`. (`JSON.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto Excel.ChartTitle original es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Excel.Interfaces.ChartTitleData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

format

Representa el formato de un título del gráfico, que incluye el formato de relleno y de fuente.

readonly format: Excel.ChartTitleFormat;

Valor de propiedad

Excel.ChartTitleFormat

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

height

Devuelve el alto, en puntos, del título del gráfico. El valor es null si el título del gráfico no está visible.

readonly height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

horizontalAlignment

Especifica la alineación horizontal del título del gráfico.

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

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

left

Especifica la distancia, en puntos, desde el borde izquierdo del título del gráfico hasta el borde izquierdo del área del gráfico. El valor es null si el título del gráfico no está visible.

left: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

overlay

Especifica si el título del gráfico se superpondrá al gráfico.

overlay: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

position

Representa la posición del título del gráfico. Vea Excel.ChartTitlePosition para más información.

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

showShadow

Representa un valor booleano que determina si el título del gráfico tiene una propiedad reemplazada.

showShadow: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

text

Especifica el texto del título del gráfico.

text: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

textOrientation

Especifica el ángulo al que está orientado el texto para el título del gráfico. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente.

textOrientation: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// 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

Especifica la distancia, en puntos, desde el borde superior del título del gráfico hasta la parte superior del área del gráfico. El valor es null si el título del gráfico no está visible.

top: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

verticalAlignment

Especifica la alineación vertical del título del gráfico. Vea Excel.ChartTextVerticalAlignment para más información.

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

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

visible

Especifica si el título del gráfico está visible.

visible: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

width

Especifica el ancho, en puntos, del título del gráfico. El valor es null si el título del gráfico no está visible.

readonly width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Detalles del método

getSubstring(start, length)

Obtenga la subcadena de un título de gráfico. El salto de línea '\n' cuenta un carácter.

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

Parámetros

start: number

Posición inicial de la subcadena que se va a recuperar. Indizado con cero.

length: number

Longitud de la subcadena que se va a recuperar.

Devoluciones

Excel.ChartFormatString

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// 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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle;

Parámetros

options: Excel.Interfaces.ChartTitleLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.ChartTitle

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.ChartTitle

Ejemplos

// 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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.ChartTitle

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties: Excel.Interfaces.ChartTitleUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options: OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.ChartTitle): void;

Parámetros

properties: Excel.ChartTitle

Devoluciones

void

setFormula(formula)

Establece un valor de cadena que representa la fórmula del título del gráfico con la notación de estilo A1.

setFormula(formula: string): void;

Parámetros

formula: string

Cadena que representa la fórmula que se va a establecer.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.ChartTitle original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartTitleData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.ChartTitleData;

Devoluciones

Excel.Interfaces.ChartTitleData

Excel.ChartTitle class

Comentarios

Propiedades

Métodos

Detalles de las propiedades

context

Valor de propiedad

format

Valor de propiedad

Comentarios

height

Valor de propiedad

Comentarios

horizontalAlignment

Valor de propiedad

Comentarios

left

Valor de propiedad

Comentarios

overlay

Valor de propiedad

Comentarios

position

Valor de propiedad

Comentarios

showShadow

Valor de propiedad

Comentarios

text

Valor de propiedad

Comentarios

textOrientation

Valor de propiedad

Comentarios

Ejemplos

top

Valor de propiedad

Comentarios

verticalAlignment

Valor de propiedad

Comentarios

visible

Valor de propiedad

Comentarios

width

Valor de propiedad

Comentarios

Detalles del método

getSubstring(start, length)

Parámetros

Devoluciones

Comentarios

Ejemplos

load(options)

Parámetros

Devoluciones

load(propertyNames)

Parámetros

Devoluciones

Ejemplos

load(propertyNamesAndPaths)

Parámetros

Devoluciones

set(properties, options)

Parámetros

Devoluciones

set(properties)

Parámetros

Devoluciones

setFormula(formula)

Parámetros

Devoluciones

Comentarios

toJSON()

Devoluciones

Comentarios

Recursos adicionales