Interface: ChoroplethCalc

Experimental

Extends

• GeoCalc

Properties

Property	Modifier	Type	Description	Inherited from
drawn	readonly	DrawnRegions | undefined	Experimental The regions that are drawn; undefined while unresolved.	-
elevation?	readonly	Float64Array<ArrayBufferLike>	Experimental elevation per location as a number, NaN where it is not one; undefined without the attribute. The height of the regions on a 3D globe (globe.ts), and a field of event data.	-
features?	readonly	readonly (LocatedFeature | undefined)[]	Experimental The feature each location names; undefined where it names none, and while unresolved.	-
fit?	readonly	object	Experimental The trace's part in fitbounds: the coordinates the view should hold, in degrees, and the px to keep free around them (half the largest marker). Absent when the trace has none.	GeoCalc.fit
fit.lat	readonly	ArrayLike<number>	-	-
fit.lon	readonly	ArrayLike<number>	-	-
fit.pad?	public	number	-	-
lat?	readonly	Float64Array<ArrayBufferLike>	Experimental	-
length	readonly	number	Experimental Location count: the shorter of locations and z.	-
locations?	readonly	LocationsRequest	Experimental Set by a trace given by locations: what they are and what they name (locationsOf). The layout pass loads what they are matched against and calls located.	GeoCalc.locations
lon?	readonly	Float64Array<ArrayBufferLike>	Experimental The point of each location's feature, in degrees (Plotly's ct): where its hover label and keyboard stop are, and what a box or lasso selects it by. NaN where there is none.	-
subplot	public	GeoSubplot | undefined	Experimental The subplot the trace is drawn on, set by geoCrossTraceLayout.	GeoCalc.subplot
unresolved	readonly	boolean	Experimental What the locations are matched against is not in hand (it is loading, or could not be loaded): the trace has no regions.	-
z	readonly	Float64Array	Experimental z per location as a number; NaN where it is not one (the region is not drawn).	-

Methods

located()?

optional located(result): void;

Experimental

Called in every layout pass on a trace with locations, before the view is fitted: with the features and points of its locations, or with undefined while what they are matched against is loading or could not be loaded. The trace sets what follows from them, its fit included. An answer that did not change is the same object as in the pass before.

Parameters

Parameter	Type
result	LocationsResult | undefined

Returns

void

Inherited from

GeoCalc.located;