Hoja
Una hoja en una hoja de cálculo.
Representación JSON |
---|
{ "properties": { object ( |
Campos | |
---|---|
properties
|
Las propiedades de la hoja. |
data[]
|
Datos en la cuadrícula, si es una hoja de cuadrícula
La cantidad de objetos GridData que se muestran depende de la cantidad de rangos solicitados en esta hoja. Por ejemplo, si esto representa
Para una hoja |
merges[]
|
Los rangos que se combinan. |
conditionalFormats[]
|
Son las reglas de formato condicional que se incluyen en esta hoja. |
filterViews[]
|
El filtro ve esta hoja. |
protectedRanges[]
|
Los rangos protegidos en esta hoja. |
basicFilter
|
El filtro de esta hoja, si corresponde. |
charts[]
|
Las especificaciones de todos los gráficos de esta hoja. |
bandedRanges[]
|
Los rangos con bandas (colores alternados) de esta hoja. |
developerMetadata[]
|
Los metadatos del desarrollador asociados con una hoja. |
rowGroups[]
|
Todos los grupos de filas de esta hoja, ordenados por aumento del índice de inicio del rango y, luego, por profundidad del grupo. |
columnGroups[]
|
Todos los grupos de columnas en esta hoja, ordenados por aumento del índice de inicio del rango y, luego, por profundidad del grupo. |
slicers[]
|
Los controles de filtro de esta hoja. |
Propiedades de la hoja
Propiedades de una hoja.
Representación JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Campos | |
---|---|
sheetId
|
El ID de la hoja. Must be non-negative (La precisión de las coordenadas de latitud y longitud, en metros. No debe ser un valor negativo). Una vez que configures este campo, no podrás cambiarlo. |
title
|
Es el nombre de la hoja. |
index
|
El índice de la hoja dentro de la hoja de cálculo. Cuando se agregan o actualizan propiedades de la hoja, si se excluye este campo, la hoja se agregará o se moverá al final de la lista de hojas. Cuando se actualizan los índices de hojas o se insertan hojas, se considera el movimiento en los índices "antes de mover". Por ejemplo, si hubiera 3 hojas (S1, S2, S3) para mover S1 antes que S2, se tendría que establecer el índice en 2. La solicitud de actualización del índice de la hoja se ignora si el índice solicitado es idéntico al índice actual de las hojas o si el índice nuevo solicitado es igual al índice actual de la hoja + 1. |
sheetType
|
Es el tipo de hoja. La configuración predeterminada es |
gridProperties
|
Propiedades adicionales de la hoja si esta es una cuadrícula. (Si la hoja es una hoja de objeto que contiene un gráfico o una imagen, este campo no aparece). Cuando se escribe, se produce un error al establecer cualquier propiedad de la cuadrícula en las hojas que no sean cuadrículas.
Si esta es una hoja de |
tabColor
|
El color de la pestaña en la IU Obsoleto: Usa |
tabColorStyle
|
El color de la pestaña en la IU Si también se configura |
rightToLeft
|
Verdadero si la hoja es una hoja de derecha a izquierda en lugar de una hoja de izquierda a derecha. |
dataSourceSheetProperties
|
Solo salida. Si está presente, el campo contiene propiedades específicas de la hoja |
Tipo de hoja
Es el tipo de hoja.
Enumeradores | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
Valor predeterminado, no usar. |
GRID
|
La hoja es una cuadrícula. |
OBJECT
|
La hoja no tiene cuadrícula y, en su lugar, tiene un objeto como un gráfico o una imagen. |
DATA_SOURCE
|
La hoja se conecta con un DataSource externo y muestra la vista previa de los datos.
|
Propiedades de cuadrícula
Propiedades de una cuadrícula
Representación JSON |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
Campos | |
---|---|
rowCount
|
La cantidad de filas en la cuadrícula. |
columnCount
|
La cantidad de columnas en la cuadrícula. |
frozenRowCount
|
La cantidad de filas que se inmovilizan en la cuadrícula. |
frozenColumnCount
|
La cantidad de columnas que están inmovilizadas en la cuadrícula. |
hideGridlines
|
Verdadero si la cuadrícula no muestra líneas de cuadrícula en la IU. |
rowGroupControlAfter
|
Verdadero si el botón de activación del control de agrupación de filas se muestra después del grupo. |
columnGroupControlAfter
|
Verdadero si el control de agrupación de columnas se muestra después del grupo. |
DataSourceSheetProperties
Propiedades adicionales de la hoja DATA_SOURCE
.
Representación JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Campos | |
---|---|
dataSourceId
|
ID de la |
columns[]
|
Son las columnas que se muestran en la hoja, que corresponden a los valores en
|
dataExecutionStatus
|
El estado de ejecución de los datos. |
Datos de cuadrícula
Datos en la cuadrícula, así como metadatos sobre las dimensiones.
Representación JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Campos | |
---|---|
startRow
|
La primera fila a la que hace referencia GridData, basada en cero. |
startColumn
|
La primera columna a la que hace referencia GridData, basada en cero. |
rowData[]
|
Los datos en la cuadrícula, una entrada por fila, que comienza con la fila en startRow. Los valores en RowData corresponderán a las columnas que comienzan en |
rowMetadata[]
|
Metadatos sobre las filas solicitadas en la cuadrícula, a partir de la fila en |
columnMetadata[]
|
Metadatos sobre las columnas solicitadas en la cuadrícula, a partir de la columna en |
DatosDeFila
Datos sobre cada celda en una fila.
Representación JSON |
---|
{
"values": [
{
object (
|
Campos | |
---|---|
values[]
|
Los valores de la fila, uno por columna. |
Propiedades de dimensión
Propiedades sobre una dimensión.
Representación JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
Campos | |
---|---|
pixelSize
|
Es la altura (si es una fila) o el ancho (si es una columna) de la dimensión en píxeles. |
developerMetadata[]
|
Los metadatos del desarrollador asociados con una sola fila o columna. |
dataSourceColumnReference
|
Solo salida. Si se configura, se trata de una columna en una hoja de fuente de datos. |
Regla de formato condicional
Es una regla que describe un formato condicional.
Representación JSON |
---|
{ "ranges": [ { object ( |
Campos | |
---|---|
ranges[]
|
Los rangos que tienen formato si la condición es verdadera. Todos los rangos deben estar en la misma cuadrícula. |
Campo de unión rule . Es la regla que controla este formato condicional.
rule puede ser solo una de las siguientes opciones:
|
|
booleanRule
|
El formato está "activado" o "desactivado" según la regla. |
gradientRule
|
El formato variará según los gradientes de la regla. |
Regla booleana
Una regla que puede coincidir o no, según la condición.
Representación JSON |
---|
{ "condition": { object ( |
Campos | |
---|---|
condition
|
La condición de la regla. Si la condición se evalúa como verdadera, se aplica el formato. |
format
|
El formato que se aplicará. El formato condicional solo puede aplicar un subconjunto de formato: |
Regla de gradiente
Una regla que aplica un formato de escala de colores de gradiente según los puntos de interpolación enumerados. El formato de una celda varía en función de su contenido en comparación con los valores de los puntos de interpolación.
Representación JSON |
---|
{ "minpoint": { object ( |
Campos | |
---|---|
minpoint
|
Punto de interpolación inicial |
midpoint
|
Punto de interpolación intermedio opcional |
maxpoint
|
Punto de interpolación final. |
Punto de interpolación
Un solo punto de interpolación en un formato condicional de gradiente. Establecen la escala de colores del gradiente según el color, el tipo y el valor elegidos.
Representación JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color
|
El color que debe usar este punto de interpolación. Obsoleto: Usa |
colorStyle
|
El color que debe usar este punto de interpolación. Si también se configura |
type
|
Cómo debe interpretarse el valor. |
value
|
Valor que utiliza este punto de interpolación. Puede ser una fórmula. No se usa si |
Tipo de punto de interpolación
Es el tipo de punto de interpolación.
Enumeradores | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
El valor predeterminado, no usar. |
MIN
|
El punto de interpolación utiliza el valor mínimo en las celdas sobre el rango del formato condicional. |
MAX
|
El punto de interpolación utiliza el valor máximo en las celdas sobre el rango del formato condicional. |
NUMBER
|
El punto de interpolación usa exactamente el valor en InterpolationPoint.value .
|
PERCENT
|
El punto de interpolación es el porcentaje dado en todas las celdas del rango del formato condicional. Esto equivale a |
PERCENTILE
|
El punto de interpolación es el percentil determinado sobre todas las celdas en el rango del formato condicional. Esto equivale a NUMBER si el valor era: =PERCENTILE(FLATTEN(range), value / 100) (donde los errores del rango se ignoran cuando se compactan).
|
Vista de filtro
Vista de filtro
Representación JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
Campos | |
---|---|
filterViewId
|
Es el ID de la vista de filtro. |
title
|
Es el nombre de la vista de filtro. |
range
|
El rango que abarca esta vista de filtro.
Cuando se escribe, solo se puede establecer |
namedRangeId
|
El rango con nombre que respalda esta vista de filtro, si corresponde.
Cuando se escribe, solo se puede establecer |
sortSpecs[]
|
El orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Los criterios para mostrar/ocultar valores por columna. La clave del mapa es el índice de la columna, y el valor es el criterio para esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Los criterios de filtro para mostrar/ocultar valores por columna.
|
Rango protegido
Un rango protegido
Representación JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
Campos | |
---|---|
protectedRangeId
|
El ID del rango protegido. Este campo es de solo lectura. |
range
|
El rango que se protege. El rango puede ser completamente no delimitado, en cuyo caso se considera una hoja protegida.
Cuando se escribe, solo se puede establecer |
namedRangeId
|
El rango con nombre que respalda este rango protegido, si corresponde.
Cuando se escribe, solo se puede establecer |
description
|
Es la descripción de este rango protegido. |
warningOnly
|
Verdadero si este rango protegido mostrará una advertencia al editar. La protección basada en advertencias implica que todos los usuarios pueden editar datos del rango protegido, excepto que estos aparecerán una advertencia en los que se solicitará la confirmación de la edición.
Cuando escribes: si este campo es verdadero, se ignora |
requestingUserCanEdit
|
Verdadero si el usuario que solicitó este rango protegido puede editar el área protegida. Este campo es de solo lectura. |
unprotectedRanges[]
|
La lista de rangos sin protección dentro de una hoja protegida. Los rangos desprotegidos solo se admiten en las hojas protegidas. |
editors
|
Los usuarios y grupos con acceso de edición al rango protegido. Este campo solo es visible para los usuarios que tengan acceso de edición al rango protegido y al documento. Los editores no son compatibles con la protección |
Editores
Los editores de un rango protegido.
Representación JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Campos | |
---|---|
users[]
|
Las direcciones de correo electrónico de los usuarios con acceso de edición al rango protegido. |
groups[]
|
Las direcciones de correo electrónico de los grupos con acceso de edición al rango protegido. |
domainUsersCanEdit
|
Verdadero si alguien del dominio del documento tiene acceso de edición al rango protegido. La protección del dominio solo es compatible con documentos dentro de un dominio. |
FiltroBásico
El filtro predeterminado asociado con una hoja.
Representación JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
El rango que abarca el filtro. |
sortSpecs[]
|
El orden de clasificación por columna. Las especificaciones posteriores se usan cuando los valores son iguales en las especificaciones anteriores. |
criteria
|
Los criterios para mostrar/ocultar valores por columna. La clave del mapa es el índice de la columna, y el valor es el criterio para esa columna.
Este campo dejó de estar disponible y se reemplazó por |
filterSpecs[]
|
Los criterios de filtro por columna.
|
Rango de banda
Una gama con bandas (colores alternados) en una hoja.
Representación JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Campos | |
---|---|
bandedRangeId
|
Es el ID del rango con bandas. |
range
|
El rango en el que se aplican estas propiedades. |
rowProperties
|
Propiedades de las bandas de fila Estas propiedades se aplican fila por fila en todas las filas del rango. Se debe especificar, al menos, uno de los valores |
columnProperties
|
Propiedades de las bandas de columnas Estas propiedades se aplican columna por columna en todas las columnas del rango. Se debe especificar, al menos, uno de los valores |
Propiedades de la banda
Propiedades que hacen referencia a una sola dimensión (fila o columna) Si se configuran BandedRange.row_properties
y BandedRange.column_properties
, los colores de relleno se aplican a las celdas según las siguientes reglas:
-
headerColor
yfooterColor
tienen prioridad sobre los colores de la correa. -
firstBandColor
tiene prioridad sobresecondBandColor
. -
rowProperties
tiene prioridad sobrecolumnProperties
.
Por ejemplo, el color de la primera fila tiene prioridad sobre el color de la primera, pero el color de la primera fila tiene prioridad sobre el color de la segunda fila. Del mismo modo, el encabezado de filas tiene prioridad sobre el encabezado de las columnas en la celda superior izquierda, pero tiene prioridad sobre el color de la primera fila si no se configura.
Representación JSON |
---|
{ "headerColor": { object ( |
Campos | |
---|---|
headerColor
|
El color de la primera fila o columna. Si se configura este campo, la primera fila o columna se rellena con este color y los colores alternan entre |
headerColorStyle
|
El color de la primera fila o columna. Si se configura este campo, la primera fila o columna se rellena con este color y los colores alternan entre |
firstBandColor
|
Es el primer color alternativo. (Obligatorio) Obsoleto: Usa |
firstBandColorStyle
|
Es el primer color alternativo. (Obligatorio) Si también se configura |
secondBandColor
|
Segundo color alternativo (Obligatorio) Obsoleto: Usa |
secondBandColorStyle
|
Segundo color alternativo (Obligatorio) Si también se configura |
footerColor
|
El color de la última fila o columna. Si no se configura este campo, la última fila o columna se llenará con |
footerColorStyle
|
El color de la última fila o columna. Si no se configura este campo, la última fila o columna se llenará con |
Grupo de dimensiones
Un grupo sobre un intervalo de filas o columnas en una hoja, que puede contener o estar contenido en otros grupos. Un grupo se puede contraer o expandir como una unidad en la hoja.
Representación JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
El rango en el que existe este grupo. |
depth
|
La profundidad del grupo, que representa cuántos grupos tienen un rango que contiene completamente el rango de este. |
collapsed
|
Este campo es verdadero si este grupo está contraído. Un grupo contraído permanece contraído si se expande un grupo superpuesto en una profundidad más superficial. Un valor verdadero no implica que todas las dimensiones del grupo estén ocultas, ya que su visibilidad puede cambiar de forma independiente de esta propiedad del grupo. Sin embargo, cuando se actualiza esta propiedad, todas las dimensiones que contiene se ocultan si el campo es verdadero o se configura si el valor es falso. |
Control de filtro
Un control de filtro en una hoja.
Representación JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Campos | |
---|---|
slicerId
|
Es el ID del control de filtro. |
spec
|
Es la especificación del control de filtro. |
position
|
Es la posición del control de filtro. Ten en cuenta que el control de filtro se puede colocar solo en la hoja existente. Además, el ancho y la altura del control de filtro se pueden ajustar automáticamente para mantenerlo dentro de los límites permitidos. |
Especificación de Slicer
Las especificaciones de un control de filtro
Representación JSON |
---|
{ "dataRange": { object ( |
Campos | |
---|---|
dataRange
|
El rango de datos del control de filtro. |
filterCriteria
|
Los criterios de filtrado del control de filtro. |
columnIndex
|
El índice de columna en la tabla de datos en la que se aplica el filtro. |
applyToPivotTables
|
Verdadero si el filtro debe aplicarse a tablas dinámicas. Si no está configurado, se establece de forma predeterminada como |
title
|
Es el título del control de filtro. |
textFormat
|
Corresponde al formato de texto del título en el control de filtro. El campo del vínculo no es compatible. |
backgroundColor
|
El color de fondo del control de filtro Obsoleto: Usa |
backgroundColorStyle
|
El color de fondo del control de filtro Si también se configura |
horizontalAlignment
|
Alineación horizontal del título en el control de filtro Si no se especifica, el valor predeterminado es |