PowerPoint.ShapeLineFormat class
Representa el formato de línea del objeto shape. Para imágenes y formas geométricas, el formato de línea representa el borde de la forma.
- Extends
Comentarios
[ Conjunto de API: PowerPointApi 1.4 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
// Get the type of shape for every shape in the collection.
const shapes = context.presentation.slides.getItemAt(0).shapes;
shapes.load("type");
await context.sync();
// Change the dash style for shapes of the type `line`.
shapes.items.forEach((shape) => {
if (shape.type === PowerPoint.ShapeType.line) {
shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
}
});
await context.sync();
});
Propiedades
| color | Representa el color de línea en formato de color HTML, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja"). |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| dash |
Representa el estilo de guion de la línea. Devuelve un valor null cuando la línea no es visible o hay distintos estilos de guión. Vea PowerPoint.ShapeLineDashStyle para obtener más información. |
| style | Indica el estilo de línea de la forma. Devuelve un valor null cuando la línea no es visible o hay distintos estilos. Vea PowerPoint.ShapeLineStyle para obtener más información. |
| transparency | Especifica el porcentaje de transparencia de la línea como un valor de 0,0 (opaco) a 1,0 (claro). Devuelve un valor nulo cuando la transparencia de la forma es incoherente. |
| visible | Especifica si el formato de línea de un elemento de forma está visible. Devuelve |
| weight | Indica el grosor de la línea, en puntos. Devuelve |
Métodos
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
color
Representa el color de línea en formato de color HTML, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
color: string;Valor de propiedad
string
Comentarios
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
dashStyle
Representa el estilo de guion de la línea. Devuelve un valor null cuando la línea no es visible o hay distintos estilos de guión. Vea PowerPoint.ShapeLineDashStyle para obtener más información.
dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";Valor de propiedad
PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
Comentarios
[ Conjunto de API: PowerPointApi 1.4 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
// Get the type of shape for every shape in the collection.
const shapes = context.presentation.slides.getItemAt(0).shapes;
shapes.load("type");
await context.sync();
// Change the dash style for shapes of the type `line`.
shapes.items.forEach((shape) => {
if (shape.type === PowerPoint.ShapeType.line) {
shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
}
});
await context.sync();
});
style
Indica el estilo de línea de la forma. Devuelve un valor null cuando la línea no es visible o hay distintos estilos. Vea PowerPoint.ShapeLineStyle para obtener más información.
style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";Valor de propiedad
PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
Comentarios
transparency
Especifica el porcentaje de transparencia de la línea como un valor de 0,0 (opaco) a 1,0 (claro). Devuelve un valor nulo cuando la transparencia de la forma es incoherente.
transparency: number;Valor de propiedad
number
Comentarios
visible
Especifica si el formato de línea de un elemento de forma está visible. Devuelve null cuando la forma tiene visibilidades incoherentes.
visible: boolean;Valor de propiedad
boolean
Comentarios
weight
Indica el grosor de la línea, en puntos. Devuelve null cuando la línea no está visible o hay grosores de línea incoherentes.
weight: number;Valor de propiedad
number
Comentarios
Detalles del método
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?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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[]): PowerPoint.ShapeLineFormat;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
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;
}): PowerPoint.ShapeLineFormat;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
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 original PowerPoint.ShapeLineFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeLineFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;