Interface BasemapsModelMembers

Documentation for the members of BasemapsModel.

interface BasemapsModelMembers {
    add(item: BasemapItem | Partial<BasemapItemMembers>): BasemapsModel;
    get basemaps(): BasemapItem[];
    set basemaps(value: (BasemapItem | Partial<BasemapItemMembers>)[]): void;
    clear(): BasemapsModel;
    get filteredBasemaps(): BasemapItem[];
    findItemByBasemap(basemap: Basemap): undefined | BasemapItem;
    findItemById(id: string): undefined | BasemapItem;
    isEmpty(): boolean;
    remove(item: Pick<BasemapItem, "id">): BasemapsModel;
    removeById(id: string): BasemapsModel;
    selected: undefined | BasemapItem;
    selectedId: undefined | string;
    styleLookup: undefined | Record<string, any>;
    viewMode?: "2D" | "3D";
}

Index

Properties

selected selectedId styleLookup viewMode?

Accessors

basemaps filteredBasemaps

Methods

add clear findItemByBasemap findItemById isEmpty remove removeById

Properties

`Readonly`selected

selected: undefined | BasemapItem

Getter for the selected basemap item.

selectedId

selectedId: undefined | string

Id of selected basemap item.

styleLookup

styleLookup: undefined | Record<string, any>

Object lookup for style classes.

`Optional`viewMode

viewMode?: "2D" | "3D"

The view currently used for the view

Accessors

basemaps

get basemaps(): BasemapItem[]
Array of basemap items.

Returns BasemapItem[]
- Defined in api.ts:36
set basemaps(value: (BasemapItem | Partial<BasemapItemMembers>)[]): void
Setter for the basemap items array.
Parameters
- value: (BasemapItem | Partial<BasemapItemMembers>)[]
Returns void
- Defined in api.ts:41

filteredBasemaps

get filteredBasemaps(): BasemapItem[]
Array of basemap items filtered by conditions. Currently the condition is the view mode.

Returns BasemapItem[]
The filtered basemaps.
- Defined in api.ts:31

Methods

add

add(item: BasemapItem | Partial<BasemapItemMembers>): BasemapsModel
Adds the basemap item to the basemaps array.
Parameters
- item: BasemapItem | Partial<BasemapItemMembers>
Returns BasemapsModel
- Defined in api.ts:51

clear

clear(): BasemapsModel
Removes all basemap items and selectedId state.

Returns BasemapsModel
- Defined in api.ts:66

findItemByBasemap

findItemByBasemap(basemap: Basemap): undefined | BasemapItem
Finds the first item referencing the given Basemap.
Parameters
- basemap: Basemap
Returns undefined | BasemapItem
- Defined in api.ts:81

findItemById

findItemById(id: string): undefined | BasemapItem
Finds the first item with the given id.
Parameters
- id: string
Returns undefined | BasemapItem
- Defined in api.ts:76

isEmpty

isEmpty(): boolean
Returns true if basemaps are empty.

Returns boolean
- Defined in api.ts:71

remove

remove(item: Pick<BasemapItem, "id">): BasemapsModel
Removes basemap item from the basemaps array.
Parameters
- item: Pick<BasemapItem, "id">
Returns BasemapsModel
- Defined in api.ts:56

removeById

removeById(id: string): BasemapsModel
Removes the basemap item with the given id from the basemaps array.
Parameters
- id: string
Returns BasemapsModel
- Defined in api.ts:61