Scatter

scatter(geo_object, property_x, property_y, region=None, marginal_plot=None, nbins=20, **kwargs)

Return a scatter plot of two given properties, marginal_plot parameter indicates if their associated histograms or distribution curves need to be plotted too.

Parameters:

Name	Type	Description	Default
geo_object	GeoRefObject	GeoRefObject (e.g. DrillHoles, BlockModel, Surface, etc.).	required
property_x	str	geo_object property to plot along the X-axis	required
property_y	str	geo_object property to plot along the Y-axis	required
region	Optional[str]	Region or condition to filter data to plot.	None
marginal_plot	Optional[ScatterMethod]	Can be None, Histogram or DistributionCurve and display respectively, the scatter plot of the two properties only, the scatter plot and the two histograms corresponding to the given properties or the scatter plot and the two distribution curves corresponding to the given properties. Value by default is None.	None
nbins	int	Refers to the number of bins on both histograms if the marginal_plot parameter equals Histogram. Value by default is 20.	20
**kwargs		Extra arguments to pass along to Plotly - Update Layout, arguments available at Plotly - Layout.	{}

Returns:

Type	Description
Figure	Plotly Figure.

scatter_matrix(geo_object, properties=None, region=None, **kwargs)

Return correlation scatter plot of given properties belonging to a single GeoRefObject.

Parameters:

Name	Type	Description	Default
geo_object	GeoRefObject	GeoRefObject (e.g. DrillHoles, BlockModel, Surface, etc.).	required
properties	Optional[List[str]]	List of properties belonging to the geo_object to plot or None if a plot of every property (minus built-in and internal properties) of the GeoRefObject is wanted. Default value is None.	None
region	Optional[str]	Object region or condition to select data from.	None
**kwargs		Extra arguments to pass along to Plotly - Update Layout, arguments available at Plotly - Layout.	{}

Returns:

Type	Description
Figure	Plotly Figure.

---

Last update: 2022-12-23