Class TableChartBuilder

TableChartBuilder

Compilateur pour les tableaux. Pour en savoir plus, consultez la documentation Google Charts.

Voici un exemple montrant comment créer un tableau. Les données sont importées à partir d'une feuille de calcul Google. 

// Get sample data from a spreadsheet.
const dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AF' +
    '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1';

const chartBuilder = Charts.newTableChart()
                         .setDimensions(600, 500)
                         .enablePaging(20)
                         .setDataSourceUrl(dataSourceUrl);

const chart = chartBuilder.build();

Méthodes

MéthodeType renvoyéBrève description
build()ChartCrée le graphique.
enablePaging(enablePaging)TableChartBuilderIndique s'il faut activer la pagination dans les données.
enablePaging(pageSize)TableChartBuilderActive la pagination et définit le nombre de lignes sur chaque page.
enablePaging(pageSize, startPage)TableChartBuilderActive la pagination, définit le nombre de lignes dans chaque page et la première page du tableau à afficher (les numéros de page sont basés sur zéro).
enableRtlTable(rtlEnabled)TableChartBuilderAjoute une prise en charge de base des langues de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau, de sorte que la colonne 0 est la colonne la plus à droite et la dernière colonne est la colonne la plus à gauche.
enableSorting(enableSorting)TableChartBuilderIndique s'il faut trier les colonnes lorsque l'utilisateur clique sur un en-tête de colonne.
setDataSourceUrl(url)TableChartBuilderDéfinit l'URL de la source de données utilisée pour extraire les données d'une source externe, comme Google Sheets.
setDataTable(tableBuilder)TableChartBuilderDéfinit le tableau de données à utiliser pour le graphique à l'aide d'un DataTableBuilder.
setDataTable(table)TableChartBuilderDéfinit le tableau de données contenant les lignes du graphique, ainsi que les libellés de l'axe X.
setDataViewDefinition(dataViewDefinition)TableChartBuilderDéfinit la définition de la vue de données à utiliser pour le graphique.
setDimensions(width, height)TableChartBuilderDéfinit les dimensions du graphique.
setFirstRowNumber(number)TableChartBuilderDéfinit le numéro de ligne de la première ligne du tableau de données.
setInitialSortingAscending(column)TableChartBuilderDéfinit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre croissant).
setInitialSortingDescending(column)TableChartBuilderDéfinit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre décroissant).
setOption(option, value)TableChartBuilderDéfinit les options avancées de ce graphique.
showRowNumberColumn(showRowNumber)TableChartBuilderIndique s'il faut afficher le numéro de ligne comme première colonne du tableau.
useAlternatingRowStyle(alternate)TableChartBuilderIndique si un style de couleur en alternance est attribué aux lignes impaires et paires d'un tableau.

Documentation détaillée

build()

Crée le graphique.

Renvois

Chart : objet Chart, qui peut être intégré dans des documents ou des éléments d'UI, ou utilisé comme image statique.

enablePaging(enablePaging)

Indique s'il faut activer la pagination dans les données.

Le comportement par défaut est la pagination désactivée. Si la pagination est activée, la taille de page par défaut est de 10.

Paramètres

NomTypeDescription
enablePagingBooleantrue si la pagination doit être activée, false dans le cas contraire.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

enablePaging(pageSize)

Active la pagination et définit le nombre de lignes sur chaque page.

La taille de page par défaut est de 10. 

// Creates a table chart builder and enables paging with page size of 5.
const builder = Charts.newTableChart();
builder.enablePaging(5);

Paramètres

NomTypeDescription
pageSizeIntegerNombre de lignes dans chaque page du tableau.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

enablePaging(pageSize, startPage)

Active la pagination, définit le nombre de lignes dans chaque page et la première page du tableau à afficher (les numéros de page sont basés sur zéro).

La taille de page par défaut est de 10 et la page de début par défaut est 0. 

// Creates a table chart builder and enables paging with page size of 5 and
// displays page 2 first.
const builder = Charts.newTableChart();
builder.enablePaging(5, 2);

Paramètres

NomTypeDescription
pageSizeIntegerNombre de lignes dans chaque page du tableau.
startPageIntegerPremière page du tableau à afficher (les numéros de page sont basés sur zéro).

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

enableRtlTable(rtlEnabled)

Ajoute une prise en charge de base des langues de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau, de sorte que la colonne 0 est la colonne la plus à droite et la dernière colonne est la colonne la plus à gauche.

Cela n'affecte pas l'index de colonne dans les données sous-jacentes, mais uniquement l'ordre d'affichage. La visualisation de tableau n'est pas compatible avec l'affichage complet des langues bidirectionnelles (BiDi), même avec cette option. Cette option est ignorée si vous activez la pagination (à l'aide de l'option "page") ou si le tableau comporte des barres de défilement parce que vous avez spécifié des options de hauteur et de largeur inférieures à la taille requise du tableau. Le comportement par défaut est la désactivation de la prise en charge du RTL.

Paramètres

NomTypeDescription
rtlEnabledBooleantrue si la prise en charge de la lecture de droite à gauche doit être activée, false dans le cas contraire.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

enableSorting(enableSorting)

Indique s'il faut trier les colonnes lorsque l'utilisateur clique sur un en-tête de colonne.

Si le tri est activé, les lignes sont automatiquement triées lorsque les utilisateurs cliquent sur l'en-tête de colonne. Le comportement par défaut est le tri activé.

Paramètres

NomTypeDescription
enableSortingBooleantrue pour activer le tri en cliquant sur les en-têtes de colonne, false dans le cas contraire.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setDataSourceUrl(url)

Définit l'URL de la source de données utilisée pour extraire les données d'une source externe, comme Google Sheets. Si une URL de source de données et un DataTable sont fournis, l'URL de source de données est ignorée.

Pour en savoir plus sur l'interrogation des sources de données, consultez la documentation Google Charts.

Paramètres

NomTypeDescription
urlStringURL de la source de données, y compris les paramètres de requête.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setDataTable(tableBuilder)

Définit le tableau de données à utiliser pour le graphique à l'aide d'un DataTableBuilder. Il s'agit d'une méthode pratique pour définir le tableau de données sans avoir à appeler build().

Paramètres

NomTypeDescription
tableBuilderDataTableBuilderUn outil de création de tableaux de données. Une table de données est créée instantanément lors de cet appel. Par conséquent, les modifications apportées ultérieurement au générateur ne seront pas reflétées dans le graphique.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setDataTable(table)

Définit le tableau de données contenant les lignes du graphique, ainsi que les libellés de l'axe X. La première colonne doit être une chaîne et contenir les libellés de l'axe horizontal. Vous pouvez ajouter autant de colonnes que vous le souhaitez, mais elles doivent toutes être numériques. Chaque colonne s'affiche sur une ligne distincte.

Paramètres

NomTypeDescription
tableDataTableSourceTable de données à utiliser pour le graphique.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setDataViewDefinition(dataViewDefinition)

Définit la définition de la vue de données à utiliser pour le graphique.

Paramètres

NomTypeDescription
dataViewDefinitionDataViewDefinitionObjet de définition de vue de données qui définit la vue à dériver de la source de données donnée pour le dessin du graphique.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setDimensions(width, height)

Définit les dimensions du graphique.

Paramètres

NomTypeDescription
widthIntegerLargeur du graphique, en pixels.
heightIntegerHauteur du graphique, en pixels.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setFirstRowNumber(number)

Définit le numéro de ligne de la première ligne du tableau de données.

Le numéro de ligne par défaut de la première ligne est 1. 

// Creates a table chart builder and sets the first row to be 2.
const builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

Paramètres

NomTypeDescription
numberIntegerNuméro de ligne de la première ligne du tableau de données.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setInitialSortingAscending(column)

Définit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre croissant).

La colonne est triée par ordre croissant et est marquée d'une petite flèche. 

// Creates a table chart builder and sorts it by the second column (ascending).
const builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

Paramètres

NomTypeDescription
columnIntegerNuméro de la colonne selon laquelle le tableau doit être trié initialement.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setInitialSortingDescending(column)

Définit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre décroissant).

La colonne est triée par ordre décroissant et est marquée d'une petite flèche. 

// Creates a table chart builder and sorts it by the second column (descending).
const builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

Paramètres

NomTypeDescription
columnIntegerNuméro de la colonne selon laquelle le tableau doit être trié initialement.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

setOption(option, value)

Définit les options avancées de ce graphique. Consultez les options disponibles pour ce graphique. Cette méthode n'a aucun effet si l'option fournie n'est pas valide. 

// Build a table chart which renders HTML.
const builder = Charts.newTableChart();
builder.setOption('allowHtml', {@code true});
const chart = builder.build();

Paramètres

NomTypeDescription
optionStringOption à définir.
valueObjectValeur à définir.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

showRowNumberColumn(showRowNumber)

Indique s'il faut afficher le numéro de ligne comme première colonne du tableau.

Par défaut, les numéros de ligne ne sont pas affichés.

Paramètres

NomTypeDescription
showRowNumberBooleantrue si la première colonne du tableau doit afficher le numéro de ligne, false dans le cas contraire.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.

useAlternatingRowStyle(alternate)

Indique si un style de couleur en alternance est attribué aux lignes impaires et paires d'un tableau.

Le comportement par défaut est le style de couleur alternée pour les lignes.

Paramètres

NomTypeDescription
alternateBooleantrue si les styles de couleur doivent être alternés, false dans le cas contraire.

Renvois

TableChartBuilder : ce générateur, utile pour le chaînage.