React
GeoMap, GeoMapProps, GeoDefaults, GeoDefaultsProps and 1 more: generated from the source of active-geo.
Exported by @workspace/. Generated from the package source; part of the index of every export.
Geo#
Props
- Type
readonly GeoLayer[]
- Type
GeoProjection
- Type
string
- Type
GeoHighlight | null
- Type
GeoHighlight | null
- Type
FeatureOption<Geo Selection Options>
- Type
GeoView
- Type
GeoView
- Type
GeoAttribution
- Type
string
- Type
Resettable<GeoComponents>
- Type
GeoDataset Identity
- Type
readonly GeoItem Ref[]
- Type
string
- Type
GeoDiagnostic Sink
Where diagnostics go; default the console.
- Type
GeoExport Options
- Type
boolean
- Type
FeatureOption<Geo Header Options>
- Type
number
The stage height in CSS pixels (default 420); the width is measured.
- Type
GeoHome
- Type
FeatureOption<Geo Legend Options>
- Type
readonly GeoLevel[]
- Type
ValuePresentation
The notation of numbers (BCP 47 tag or presentation); required somewhere.
- Type
Ref<GeoMap Handle>
- Type
readonly GeoItem Ref[]
- Type
string
- Type
GeoTranslate Fn
The host's words for every key of the catalogue; required somewhere.
- Type
FeatureOption<Geo Table Options>
- Type
FeatureOption<Geo Tooltip Options>
- Type
FeatureOption<Geo Zoom Options>
Events
Called by the component when something happens.
- Type
(highlight, change) => void
- Type
(selection, change) => void
- Type
(view, change) => void
- Type
(format) => void
- Type
(format, error) => void
- Type
(item, source) => void
- Type
(activation) => void
- Type
(request) => …
- Type
(request) => …
Takes only the props listed.
Geo#
Props
- Type
ReactNode
- Type
GeoAttribution
- Type
Resettable<GeoComponents>
- Type
GeoDiagnostic Sink
Where diagnostics go; default the console.
- Type
GeoExport Options
- Type
FeatureOption<Geo Header Options>
- Type
FeatureOption<Geo Legend Options>
- Type
ValuePresentation
The notation of numbers (BCP 47 tag or presentation); required somewhere.
- Type
FeatureOption<Geo Selection Options>
- Type
GeoTranslate Fn
The host's words for every key of the catalogue; required somewhere.
- Type
FeatureOption<Geo Table Options>
- Type
FeatureOption<Geo Tooltip Options>
- Type
FeatureOption<Geo Zoom Options>
Takes only the props listed.
Functions, hooks and constants#
- Type
() => GeoLegend Hook
Types#
The props of Geo, each described in its prop list on this page.
interface GeoMapProps extends GeoConfigSource {
readonly title: string;
readonly subtitle?: string;
readonly description?: string;
readonly layers: readonly GeoLayer[];
readonly projection: GeoProjection;
readonly height?: number;
readonly graticule?: boolean;
readonly selectedItems?: readonly GeoItemRef[];
readonly defaultSelectedItems?: readonly GeoItemRef[];
readonly onSelectionChange?: (
selection: GeoItemRef[],
change: GeoSelectionChange,
) => void;
readonly view?: GeoView;
readonly defaultView?: GeoView;
readonly home?: GeoHome;
readonly onViewChange?: (view: GeoView, change: GeoViewChange) => void;
readonly highlight?: GeoHighlight | null;
readonly defaultHighlight?: GeoHighlight | null;
readonly onHighlightChange?: (
highlight: GeoHighlight | null,
change: GeoHighlightChange,
) => void;
readonly onLegendActivate?: (activation: GeoLegendActivation) => void;
readonly onItemActivate?: (
item: GeoItem,
source: 'pointer' | 'keyboard' | 'touch',
) => void;
readonly onTableRequest?: (
request: GeoTableRequest,
) => GeoTableRequestOutcome | Promise<GeoTableRequestOutcome>;
readonly dataset?: GeoDatasetIdentity;
readonly levelPath?: readonly GeoLevel[];
readonly onLevelRequest?: (request: GeoLevelRequest) => void | Promise<void>;
readonly onExportComplete?: (format: GeoExportFormat) => void;
readonly onExportError?: (format: GeoExportFormat, error: Error) => void;
readonly ref?: Ref<GeoMapHandle>;
readonly className?: string;
}The props of Geo, each described in its prop list on this page.
interface GeoDefaultsProps extends GeoConfigSource {
readonly children: ReactNode;
}