@eodash/eodash / Widgets / EodashMap

Class: EodashMap ​

Guide: EodashMap

Properties ​

baseLayers? ​

Default base layers of the map, expects a layer array that will be injected to the BaseLayers group. A collection that declares its own base layers replaces these; The state defaultBaseLayers keeps them as the fallback for collections that do not declare it

ts
optional baseLayers?: EoxLayer[] = [ { type: "Tile", source: { type: "OSM" }, properties: { id: "osm", title: "Background", layerControlExclusive: true, }, }, ];

btns? ​

Toolbar feature flags; set any flag to false to hide the corresponding button.

ts
optional btns?: object = { enableExportMap: true, enableChangeProjection: true, enableCompareIndicators: true, enableBackToPOIs: true, enableSearch: true, enableZoom: true, enableGlobe: true, enableMosaic: true, enableFeedback: true, enableGeolocation: true, geolocationOptions: { style: { "circle-radius": 12, "circle-fill-color": "red", "circle-stroke-color": "white", "circle-stroke-width": 3, }, }, searchParams: {}, };

enableBackToPOIs? ​

ts
optional enableBackToPOIs?: boolean;

enableChangeProjection? ​

ts
optional enableChangeProjection?: boolean;

enableCompareIndicators? ​

ts
optional enableCompareIndicators?:
  | boolean
  | {
  compareTemplate?: string;
  fallbackTemplate?: string;
  itemFilterConfig?: Partial<{
     aggregateResults: string;
     cssVars: string | Record<string, any>;
     enableCompare: boolean;
     enableHighlighting: boolean;
     expandMultipleFilters: boolean;
     expandMultipleResults: boolean;
     filterProperties: object[];
     filtersTitle: string;
     imageProperty: string;
     resultsTitle: string;
     resultType: string;
     styleOverride: string;
     subTitleProperty: string;
     titleProperty: string;
   }> & Omit<object & VNodeProps & AllowedComponentProps & ComponentCustomProps,
     | "enableCompare"
     | "titleProperty"
     | "filtersTitle"
     | "resultsTitle"
     | "subTitleProperty"
     | "imageProperty"
     | "aggregateResults"
     | "resultType"
     | "cssVars"
     | "enableHighlighting"
     | "expandMultipleFilters"
     | "expandMultipleResults"
     | "styleOverride"
    | "filterProperties">;
};

enableExportMap? ​

ts
optional enableExportMap?: boolean;

enableFeedback? ​

ts
optional enableFeedback?: boolean;

enableGeolocation? ​

ts
optional enableGeolocation?: boolean;

enableGlobe? ​

ts
optional enableGlobe?: boolean;

enableMosaic? ​

ts
optional enableMosaic?: boolean;

enableSearch? ​

ts
optional enableSearch?: boolean;

enableZoom? ​

ts
optional enableZoom?: boolean;

geolocationOptions? ​

ts
optional geolocationOptions?: object;

searchParams? ​

ts
optional searchParams?: object;

btnsPosition? ​

Grid position of the floating button toolbar. x accepts responsive "mobile/tablet/desktop" column notation.

ts
optional btnsPosition?: object = { x: "12/9/10", y: 1, gap: 16, };

gap ​

ts
gap: number;

x ​

ts
x: string | number;

y ​

ts
y: number;

center? ​

Initial map center as [lon, lat]; falls back to the last stored map position.

ts
optional center?: [number, number] = [15, 48];

enableCompare? ​

ts
optional enableCompare?: boolean = false;

enableCursorCoordinates? ​

Show live cursor coordinates as a fixed overlay at the bottom-left of the map.

ts
optional enableCursorCoordinates?: boolean = true;

enableScaleLine? ​

Show an OpenLayers scale-line control at the bottom-left of the map.

ts
optional enableScaleLine?: boolean = true;

zoom? ​

Initial zoom level; falls back to the last stored map position.

ts
optional zoom?: number = 4;

zoomToExtent? ​

Fly to the selected collection's spatial extent on selection.

ts
optional zoomToExtent?: boolean = true;