Skip to content

GIS🍋

plot_2d(georef_object, property, agg_method, region=None, region_agg=None, colorscale='Viridis', marker_size=10, crs=None, **kwargs) 🍋

Return a 2d plot on a map of a given property belonging to a GeoRefObject.

Parameters:

Name Type Description Default
georef_object GeoRefObject

GeoRefObject.

required
property str

Property to map.

required
agg_method AggregationMethod

Aggregation data methods. See Pandas - Group By to find out supported methods.

required
region Optional[str]

Object region or condition to select data from.

None
region_agg Optional[RegionAggregationMethod]

Aggregation region method.

None
colorscale str

Set the colorscale, choices are avalaible at Plotly - Colorscales

'Viridis'
crs Optional[CRS]

Cooordinate Reference System.

None
**kwargs

Extra arguments to pass along to Plotly - Update Layout, arguments available at Plotly - Layout.

{}

Raises:

Type Description
ValueError

No CRS is provided and project has no CRS either.

Returns:

Type Description
Figure

Plotly Figure.

Example

geo.plot_2d(my_geo_ref_obj, my_prop, special_agg, my_colorscale)
geo.plot_2d(my_gis_obj, my_prop, my_colorscale)
fig = geo.plot_2d(
    [
        {"georef_object": my_grid_object, "property": my_grid_object_prop, "agg_method": grid_agg},
        {"georef_object": my_gis_obj, "property": my_gis_prop},
        {"georef_object": my_drillholes, "property": my_drillholes_prop, "agg_method":drillholes_agg},
    ],
    colorscale=my_colorscale
)

Last update: 2022-12-23