Lignes et colonnes
Facade API
La définition complète des types de l’API Facade est disponible dans la documentation de l’API Facade.
Lignes
Insérer une ligne après une position donnée
insertRowAfter(afterPosition) : insère une ligne après la position de ligne indiquée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a row after the first row positionsheet.insertRowAfter(0)Insérer une ligne avant une position donnée
insertRowBefore(beforePosition) : insère une ligne avant la position de ligne indiquée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a row before the first row positionsheet.insertRowBefore(0)Insérer plusieurs lignes à l’emplacement indiqué
insertRows(rowIndex, numRows) : insère dans une feuille une ou plusieurs lignes vides consécutives à partir de l’emplacement indiqué.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Shifts all rows down by threesheet.insertRows(0, 3)Insérer plusieurs lignes après une position donnée
insertRowsAfter(afterPosition, howMany) : insère le nombre de lignes indiqué après la position de ligne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five rows after the first rowsheet.insertRowsAfter(0, 5)Insérer plusieurs lignes avant une position donnée
insertRowsBefore(beforePosition, howMany) : insère le nombre de lignes indiqué avant la position de ligne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five rows before the first rowsheet.insertRowsBefore(0, 5)Supprimer la ligne à une position donnée
deleteRow(rowPosition) : supprime la ligne située à la position indiquée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the first rowsheet.deleteRow(0)Supprimer plusieurs lignes à partir d’une position donnée
deleteRows(rowPosition, howMany) : supprime le nombre de lignes indiqué à partir de la position de ligne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the first two rowssheet.deleteRows(0, 2)Supprimer plusieurs lignes aux positions indiquées
deleteRowsByPoints(rowPoints) : supprime plusieurs lignes, pas nécessairement consécutives, désignées par un tableau de positions.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the 3rd row and rows 5 to 7fWorksheet.deleteRowsByPoints([2, [4, 6]])Déplacer des lignes vers une nouvelle position
moveRows(rowSpec, destinationIndex) : déplace les lignes sélectionnées par la plage donnée vers la position indiquée par destinationIndex. rowSpec ne doit pas nécessairement représenter avec exactitude une ligne entière ou un groupe de lignes à déplacer : toutes les lignes traversées par la plage sont sélectionnées.
// The code below moves rows 1-2 to destination index 5// This results in those rows becoming rows 3-4const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Selects row 1 and row 2 to be movedconst rowSpec = sheet.getRange('1:2')sheet.moveRows(rowSpec, 5)Masquer les lignes d’une plage donnée
hideRow(row) : masque les lignes de la plage indiquée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This hides the first rowconst range = sheet.getRange('1:1')sheet.hideRow(range)Masquer plusieurs lignes consécutives
hideRows(rowIndex, numRows) : masque une ou plusieurs lignes consécutives à partir de l’indice donné. Cette méthode utilise des indices commençant à 0.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Hides the first three rowssheet.hideRows(0, 3)Réafficher une ligne dans une plage donnée
unhideRow(row) : réaffiche la ligne de la plage indiquée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This unhides the first row if it was previously hiddenconst range = sheet.getRange('1:1')sheet.unhideRow(range)Réafficher plusieurs lignes consécutives
showRows(rowIndex, numRows) : réaffiche une ou plusieurs lignes consécutives à partir de l’indice donné. Cette méthode utilise des indices commençant à 0.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Unhides the first three rowssheet.showRows(0, 3)Définir la hauteur d’une ligne
setRowHeight(rowPosition, height) : définit en pixels la hauteur de la ligne donnée. Par défaut, les lignes s’agrandissent pour s’adapter au contenu des cellules. Pour imposer une hauteur précise, utilisez setRowHeightsForced(startRow, numRows, height).
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first row to a height of 200 pixelssheet.setRowHeight(0, 200)Définir la hauteur de plusieurs lignes
setRowHeights(startRow, numRows, height) : définit en pixels la hauteur des lignes données. Par défaut, les lignes s’agrandissent pour s’adapter au contenu des cellules. Pour imposer une hauteur précise, utilisez setRowHeightsForced(startRow, numRows, height).
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three rows to a height of 200 pixelssheet.setRowHeights(0, 3, 200)Imposer la hauteur de plusieurs lignes
setRowHeightsForced(startRow, numRows, height) : définit en pixels la hauteur des lignes données. Par défaut, les lignes s’agrandissent pour s’adapter au contenu des cellules. Avec setRowHeightsForced, les lignes conservent la hauteur indiquée même si le contenu des cellules est plus haut.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three rows to a height of 5 pixelssheet.setRowHeightsForced(0, 3, 5)Ajuster automatiquement la hauteur des lignes
autoResizeRows(startRow, numRows) : ajuste automatiquement la hauteur des lignes données à leur contenu textuel.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set the first 3 rows to a height that fits their text.sheet.autoResizeRows(0, 3)Définir des propriétés personnalisées pour les lignes
setRowCustom(custom) : définit des propriétés personnalisées pour les lignes données. Un objet custom est enregistré sur la ligne et peut contenir toute donnée conforme au format JSON afin de stocker des informations supplémentaires.
La mise à jour des données custom écrase les données custom d’origine. Pour conserver les données custom d’origine lors d’une mise à jour, récupérez au préalable les données custom et fusionnez-les avec les nouvelles données avant d’effectuer la mise à jour.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set custom properties for the first and third rowssheet.setRowCustom({ 0: { color: 'red' }, 2: { size: 16 },})Colonnes
Insérer une colonne après une position donnée
insertColumnAfter(afterPosition) : insère une colonne après la position de colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a column after the first column positionsheet.insertColumnAfter(0)Insérer une colonne avant une position donnée
insertColumnBefore(beforePosition) : insère une colonne avant la position de colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a column in the first column positionsheet.insertColumnBefore(0)Insérer plusieurs colonnes à l’emplacement indiqué
insertColumns(columnIndex, numColumns) : insère dans une feuille une ou plusieurs colonnes vides consécutives à partir de l’emplacement indiqué.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Shifts all columns by threesheet.insertColumns(0, 3)Insérer plusieurs colonnes après une position donnée
insertColumnsAfter(afterPosition, howMany) : insère le nombre de colonnes indiqué après la position de colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Inserts two columns after the first columnsheet.insertColumnsAfter(0, 2)Insérer plusieurs colonnes avant une position donnée
insertColumnsBefore(beforePosition, howMany) : insère le nombre de colonnes indiqué avant la position de colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five columns before the first columnsheet.insertColumnsBefore(0, 5)Supprimer la colonne à une position donnée
deleteColumn(columnPosition) : supprime la colonne située à la position donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the first columnsheet.deleteColumn(0)Supprimer plusieurs colonnes à partir d’une position donnée
deleteColumns(columnPosition, howMany) : supprime le nombre de colonnes indiqué à partir de la position de colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the first two columnssheet.deleteColumns(0, 2)Supprimer plusieurs colonnes aux positions indiquées
deleteColumnsByPoints(columnPoints) : supprime plusieurs colonnes, pas nécessairement consécutives, désignées par un tableau de positions.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the Column C and Columns E-GfWorksheet.deleteColumnsByPoints([2, [4, 6]])Déplacer des colonnes vers une nouvelle position
moveColumns(columnSpec, destinationIndex) : déplace les colonnes sélectionnées par la plage donnée vers la position indiquée par destinationIndex. columnSpec ne doit pas nécessairement représenter avec exactitude une colonne entière ou un groupe de colonnes à déplacer : toutes les colonnes traversées par la plage sont sélectionnées.
// The code below moves rows A-B to destination index 5.// This results in those columns becoming columns C-D.const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Selects column A and column B to be moved.const columnSpec = sheet.getRange('A:B')sheet.moveColumns(columnSpec, 5)Masquer les colonnes d’une plage donnée
hideColumn(column) : masque la ou les colonnes de la plage donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This hides the first columnconst range = sheet.getRange('A:A')sheet.hideColumn(range)Masquer plusieurs colonnes consécutives
hideColumns(columnIndex, numColumns) : masque une ou plusieurs colonnes consécutives à partir de l’indice donné. Cette méthode utilise des indices commençant à 0.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Hides the first three columnssheet.hideColumns(0, 3)Réafficher une colonne dans une plage donnée
unhideColumn(column) : réaffiche la colonne de la plage donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This unhides the first column if it was previously hiddenconst range = sheet.getRange('A:A')sheet.unhideColumn(range)Réafficher plusieurs colonnes consécutives
showColumns(columnIndex, numColumns) : réaffiche une ou plusieurs colonnes consécutives à partir de l’indice donné. Cette méthode utilise des indices commençant à 0.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Unhides the first three columnssheet.showColumns(0, 3)Définir la largeur d’une colonne
setColumnWidth(columnPosition, width) : définit en pixels la largeur de la colonne donnée.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first column to a width of 200 pixelssheet.setColumnWidth(0, 200)Définir la largeur de plusieurs colonnes
setColumnWidths(startColumn, numColumns, width) : définit en pixels la largeur des colonnes données.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three columns to a width of 200 pixelssheet.setColumnWidths(0, 3, 200)Ajuster automatiquement la largeur des colonnes
autoResizeColumns(startColumn, numColumns) : ajuste automatiquement la largeur des colonnes données à leur contenu textuel.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set the A:C columns to a width that fits their text.sheet.autoResizeColumns(0, 3)Définir des propriétés personnalisées pour les colonnes
setColumnCustom(custom) : définit des propriétés personnalisées pour les colonnes données. Un objet custom est enregistré sur la colonne et peut contenir toute donnée conforme au format JSON afin de stocker des informations supplémentaires.
La mise à jour des données custom écrase les données custom d’origine. Pour conserver les données custom d’origine lors d’une mise à jour, récupérez au préalable les données custom et fusionnez-les avec les nouvelles données avant d’effectuer la mise à jour.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set custom properties for the first and third columnssheet.setColumnCustom({ 0: { color: 'red' }, 2: { size: 16 },})Que pensez-vous de ce guide ?