- Preparing search index...
- The search index is not available
RAMP4 - v4.7.0
Function useOverviewmapStore
- useOverviewmapStore(pinia?, hot?): Store<"overviewmap", _UnwrapAll<Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, "basemaps" | "mapConfig" | "startMinimized" | "expandFactor" | "borderColour" | "borderWidth" | "areaColour" | "areaOpacity">>, Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, never>, Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, "updateInitialBasemap">>
-
Parameters
-
Optional
pinia: null | Pinia
-
Optional
hot: StoreGeneric
Returns Store<"overviewmap", _UnwrapAll<Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, "basemaps" | "mapConfig" | "startMinimized" | "expandFactor" | "borderColour" | "borderWidth" | "areaColour" | "areaOpacity">>, Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, never>, Pick<{
areaColour: Ref<string>;
areaOpacity: Ref<number>;
basemaps: Ref<{}>;
borderColour: Ref<string>;
borderWidth: Ref<number>;
expandFactor: Ref<number>;
mapConfig: Ref<{
basemaps: ({ id: string; name: string; description: string; altText: string; hideThumbnail?: boolean | undefined; thumbnailUrl?: string | undefined; tileSchemaId: string; layers: { id: string; layerType: LayerType; url: string; opacity?: number | undefined; }[]; attribution?: { ...; } | undefined; backgroundColour?: string | u...)[];
caption?: { mapCoords?: { disabled?: boolean | undefined; formatter?: string | undefined; } | undefined; scaleBar?: { disabled?: boolean | undefined; imperialScale?: boolean | undefined; } | undefined; langToggle?: { ...; } | undefined; };
extentSets: ({ id: string; default: { xmin: number; xmax: number; ymin: number; ymax: number; spatialReference: { wkid?: number | undefined; latestWkid?: number | undefined; wkt?: string | undefined; }; }; full?: { ...; } | undefined; maximum?: { ...; } | undefined; })[];
initialBasemapId: string;
labelsDefault?: { visible?: boolean | undefined; };
layerTimeDefault?: { expectedDrawTime?: number | undefined; expectedLoadTime?: number | undefined; };
lodSets: ({ id: string; lods: { level: number; resolution: number; scale: number; }[]; })[];
mapMouseThrottle?: number;
pointZoomScale?: number;
tileSchemas: ({ id: string; name: string; extentSetId: string; lodSetId: string; thumbnailTileUrls: string[]; hasNorthPole?: boolean | undefined; recoveryBasemap?: { basemapId: string; timeout?: number | undefined; } | undefined; })[];
}>;
startMinimized: Ref<boolean>;
updateInitialBasemap: ((basemapId) => void);
}, "updateInitialBasemap">>
Returns a store, creates it if necessary.