LandmarkStore class Places
Provides access to a landmark store and its operations.
This class should not be instantiated directly. Instead, use the related methods from LandmarkStoreService to obtain an instance.
It represents a single persistence store instance and is the primary entry point for reading, adding, updating and removing landmark data and categories, plus creating scoped browse sessions for iterative access.
Typical tasks include enumerating and filtering landmarks (by category or geographic area), creating and modifying categories, importing external landmark datasets. Main members expose store identity and metadata, collections of category and landmark objects.
Can be presented on the map using the LandmarkStoreCollection associated with a GemMapController, in for custom search operations and for alerts.
Properties
-
categories
→ List<
LandmarkCategory> -
Get the list of all categories.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → int
-
Get the ID of the landmark store.
no setter
- image → Img
-
Get the landmark store image.
no setter
- mapId → int
-
no setter
- name → String
-
Get the landmark store name.
no setter
- pointerId → int
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → LandmarkStoreType
-
Get the type of the landmark store.
no setter
Methods
-
addCategory(
LandmarkCategory category) → void - Add a new category to the store.
-
addLandmark(
Landmark landmark, {int categoryId = LandmarkStore.uncategorizedLandmarkCategId}) → void - Add a landmark to the specified category in the landmark store.
-
cancelImportLandmarks(
) → void - Cancel async import landmarks operation
-
containsLandmark(
int landmarkId) → bool - Checks if the landmark store contains the landmark ID
-
createLandmarkBrowseSession(
{LandmarkBrowseSessionSettings? settings}) → LandmarkBrowseSession - Create a landmarks browse session with the specified settings
-
dispose(
) → void -
getCategoriesFromLandmark(
int landmarkId) → List< LandmarkCategory> - Get the list of categories for the specified landmark.
-
getCategoryById(
int categoryId) → LandmarkCategory? - Get the category by ID.
-
getFilePath(
) → String - Get landmark store path.
-
getLandmark(
int landmarkId) → Landmark? - Get the specified landmark.
-
getLandmarkCount(
{int categoryId = LandmarkStore.invalidLandmarkCategId}) → int - Get the number of all landmarks within the specified category.
-
getLandmarks(
{int categoryId = LandmarkStore.invalidLandmarkCategId}) → List< Landmark> - Get the landmarks within the specified category.
-
getLandmarksInArea(
{GeographicArea? area, int categoryId = LandmarkStore.invalidLandmarkCategId}) → List< Landmark> - Get the landmarks within the specified area.
-
importLandmarks(
{required String filePath, required LandmarkFileFormat format, required Img image, void onCompleteCallback(GemError error)?, void onComplete(GemError error)?, void onProgressUpdated(int progress)?, int categoryId = uncategorizedLandmarkCategId}) → ProgressListener? - Asynchronously import landmarks from given file format
-
importLandmarksWithDataBuffer(
{required Uint8List buffer, required LandmarkFileFormat format, required Img image, void onCompleteCallback(GemError error)?, void onComplete(GemError error)?, void onProgressUpdated(int progress)?, int categoryId = uncategorizedLandmarkCategId}) → ProgressListener? - Asynchronously import landmarks from given buffer format
-
isFastUpdateMode(
) → bool - Get fast update mode state.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerAutoReleaseObject(
int pointerId) → void -
Registers an object for auto release.
inherited
-
removeAllLandmarks(
) → void - Remove all landmarks from store.
-
removeCategory(
int categoryId, {bool removeLmkContent = false}) → void - Remove the specified category.
-
removeLandmark(
Landmark landmark) → void - Remove the specified landmark.
-
setImage(
Img image) → GemError - Set the landmark store image.
-
setLandmarkCategory(
Landmark landmark, int categoryId) → void - Set landmark category id
-
startFastUpdateMode(
) → void - Start landmark store fast update mode
-
stopFastUpdateMode(
{bool discard = false}) → void - Stop landmark store fast update mode.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateCategory(
LandmarkCategory category) → void - Update the specified category.
-
updateLandmark(
Landmark landmark) → void - Update the information about a landmark.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- invalidLandmarkCategId → const int
- The constant for the invalid landmark category ID.
- uncategorizedLandmarkCategId → const int
- The constant for the uncategorized landmark category ID.