TableCellStyle
The object for applying styles to cells in a table.
Declaration
object TableCellStyleProperties
| Name | Type | Description |
|---|---|---|
backgroundColor | Color | The background color for the cell. If you omit this property, the background is transparent. The cell background color is highest priority, followed by the column, and finally the row. Apple News applies all three colors, meaning that non-opaque values can cause combined colors. For example, using a red row together with a blue cell, both with 50% opacity, creates a purple cell. |
border | TableBorder | The border for the cell. Because the border is inside the cell, it affects the size of the content within the cell. The bigger the border, the less available space for content. |
conditional | [ConditionalTableCellStyle] | An array of styles you apply to cells that meet specified conditions. You can use this to change the appearance of specific table cells. |
height | (SupportedUnits | number) | The height of the cell and its row, as a number in points, or using one of the units of measure for components.See Specifying Measurements for Components. By default, the height of each row is determined by the height of the content in that row. |
horizontalAlignment | string | Defines the horizontal alignment of content inside cells. |
minimumWidth | (SupportedUnits | number) | The minimum width of the cell and its column, as a number in points or in one of the available units of measure for components. See Specifying Measurements for Components. |
padding | (SupportedUnits | Padding | number) | The space around the content in a table cell in points, supported units, or a Padding object that specifies padding for each side separately. |
textStyle | (ComponentTextStyle | string) | The name string of one of your styles in the Article ArticleDocument.componentTextStyles object. |
verticalAlignment | string | Defines the vertical alignment of content inside cells. |
width | integer | The column width, as a percentage only. This property only indicates proportionate width; you can’t use it to control exact width. See |
Discussion
You can apply styles that affect the look of the cells in your tables, including the background color, the horizontal alignment of cell contents, and the cell height, width, and padding.
You can also specify conditional styles for cells — styles applied to cells that meet certain criteria. For example, you might choose to change the background color for a cell at a specific location. See ConditionalTableCellStyle for more information.
You can use this object in TableStyle.
Example
{
"components": [
{
"role": "datatable",
"style": "bookTableStyle",
"showDescriptorLabels": true,
"sortBy": [
{
"descriptor": "id-publication-date",
"direction": "ascending"
}
],
"data": {
"descriptors": [
{
"identifier": "id-publication-date",
"key": "publicationDate",
"label": "Date",
"dataType": "string"
},
{
"identifier": "id-title",
"key": "title",
"label": "Title",
"dataType": "string"
},
{
"identifier": "id-publisher",
"key": "publisher",
"label": "Publisher",
"dataType": "string"
}
],
"records": [
{
"title": "Mardi",
"publicationDate": "1849",
"publisher": "Harper & Brothers"
},
{
"title": "Typee",
"publicationDate": "1846",
"publisher": "Wiley and Putnam"
},
{
"title": "White-Jacket",
"publicationDate": "1850",
"publisher": "Harper & Brothers"
},
{
"title": "Omoo",
"publicationDate": "1847",
"publisher": "Harper & Brothers"
},
{
"title": "Redburn",
"publicationDate": "1849",
"publisher": "Harper & Brothers"
},
{
"title": "Moby-Dick",
"publicationDate": "1851",
"publisher": "Harper & Brothers"
}
]
}
}
],
"componentStyles": {
"bookTableStyle": {
"tableStyle": {
"columns": {
"backgroundColor": "#eeeeee",
"conditional": [
{
"selectors": [
{
"columnIndex": 0
}
],
"backgroundColor": "#dddddd"
}
]
},
"headerCells": {
"padding": 5,
"textStyle": {
"fontWeight": "bold"
}
},
"cells": {
"padding": 2
}
}
}
}
}