Page Summary
-
Dictionaries can be renamed using the
renamemethod. -
The
renamemethod takes a list of keys to rename (from), a list of new names (to), and an optionaloverwriteboolean. -
The
fromandtolists must have the same length. -
The
overwriteparameter allows replacing existing keys with the new names.
| Usage | Returns |
|---|---|
Dictionary.
rename
(from, to, overwrite
)
|
Dictionary |
| Argument | Type | Details |
|---|---|---|
|
this:
dictionary
|
Dictionary | |
from
|
List | A list of keys to be renamed. |
to
|
List | A list of the new names for the keys listed in the 'from' parameter. Must have the same length as the 'from' list. |
overwrite
|
Boolean, default: false | Allow overwriting existing properties with the same name. |
Examples
Code Editor (JavaScript)
// A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image). var dict = ee . Dictionary ({ B1 : 182 , B2 : 219 , B3 : 443 }); // Define from-to key name lists for selected keys. var from = [ 'B2' , 'B3' ]; var to = [ 'Band_2' , 'Band_3' ]; print ( 'Renamed keys' , dict . rename ( from , to )); print ( 'Overwrite existing key names, e.g. B3 becomes B1' , dict . rename ({ from : [ 'B3' ], to : [ 'B1' ], overwrite : true }));
import ee import geemap.core as geemap
Colab (Python)
# A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image). dic = ee . Dictionary ({ 'B1' : 182 , 'B2' : 219 , 'B3' : 443 }) # Define from-to key name lists for selected keys. frm = [ 'B2' , 'B3' ] to = [ 'Band_2' , 'Band_3' ] display ( 'Renamed keys:' , dic . rename ( frm , to )) dic_overwrite = dic . rename ( ** { 'from' : [ 'B3' ], 'to' : [ 'B1' ], 'overwrite' : True }) display ( 'Overwrite existing key names, e.g. B3 becomes B1:' , dic_overwrite )
