sepal_ui.aoi.aoi_tile.AoiTile#

class sepal_ui.aoi.aoi_tile.AoiTile(**kwargs)[source]#

sw.Tile tailored for the selection of an aoi. it is meant to be used with the aoi. it can be bound to EarthEngine (GAUl 2015 administrative definition) or stay with the GADM Python implementation.

Parameters:

methods (str | List[str]) – the methods to select the aoi (more information in AoiView), default to ‘ALL’. Available: {ADMIN0, ADMIN1, ADMIN2, SHAPE, DRAW, POINTS, ASSET, ALL}
gee (bool) – whether or not to use the python EartEngine API. default to True
vector (str | Path) – the path to the default vector object
admin (int | str) – the administrative code of the default selection. Need to be GADM if ee==False and GAUL 2015 if ee==True.
asset (str | Path) – the default asset. Can only work if ee==True.
map_style (dict | None) – the predefined style of the aoi. It’s by default using a “success” sepal_ui.color with 0.5 transparent fill color. It can be completely replace by a fully qualified style dictionary. Use the sepal_ui.color object to define any color to remain compatible with light and dark theme.
folder (str | Path)

Attributes

`map`	a SepalMap object to display the selected aoi
`view`	an AoiView object to handle the aoi method selection

Methods

__init__

sw.Tile tailored for the selection of an aoi.

AoiTile.__init__(methods='ALL', gee=True, vector='', admin='', asset='', folder='', map_style=None, **kwargs)[source]#

sw.Tile tailored for the selection of an aoi. it is meant to be used with the aoi. it can be bound to EarthEngine (GAUl 2015 administrative definition) or stay with the GADM Python implementation.

Parameters:

methods (str | List[str]) – the methods to select the aoi (more information in AoiView), default to ‘ALL’. Available: {ADMIN0, ADMIN1, ADMIN2, SHAPE, DRAW, POINTS, ASSET, ALL}
gee (bool) – whether or not to use the python EartEngine API. default to True
vector (str | Path) – the path to the default vector object
admin (int | str) – the administrative code of the default selection. Need to be GADM if ee==False and GAUL 2015 if ee==True.
asset (str | Path) – the default asset. Can only work if ee==True.
map_style (dict | None) – the predefined style of the aoi. It’s by default using a “success” sepal_ui.color with 0.5 transparent fill color. It can be completely replace by a fully qualified style dictionary. Use the sepal_ui.color object to define any color to remain compatible with light and dark theme.
folder (str | Path)

Return type:

None