Pixi’VNClass: MapStoredClass
Defined in: src/classes/navigation/MapStoredClass.ts:7
Extends
default
Extended by
Implements
MapBaseInternalInterface
Constructors
Constructor
> new MapStoredClass(id, activities?): MapStoredClass
Defined in: src/classes/navigation/MapStoredClass.ts:11
Parameters
id
string
activities?
(string | ActivityInterface)[] = []
Returns
MapStoredClass
Overrides
NavigationAbstractClass.constructor
Properties
id
> readonly id: string
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41
Is id of the stored class. is unique for this class.
Implementation of
MapBaseInternalInterface.id
Inherited from
NavigationAbstractClass.id
Accessors
activities
Get Signature
> get activities(): ActivityInterface[]
Defined in: src/classes/navigation/NavigationAbstractClass.ts:176
The activities associated with this class, filtered based on their scheduling.
Returns
Implementation of
MapBaseInternalInterface.activities
Inherited from
NavigationAbstractClass.activities
activitiesIds
Get Signature
> get activitiesIds(): string[]
Defined in: src/classes/navigation/NavigationAbstractClass.ts:69
All the ids of the activities associated with this class. Compared to activities, they are not filtered based on their scheduling.
Returns
string[]
Implementation of
MapBaseInternalInterface.activitiesIds
Inherited from
NavigationAbstractClass.activitiesIds
locations
Get Signature
> get locations(): LocationInterface[]
Defined in: src/classes/navigation/MapStoredClass.ts:15
Get all locations in the map.
Returns
The locations in the map.
Implementation of
MapBaseInternalInterface.locations
Methods
addActivity()
> addActivity(activity, options?): void
Defined in: src/classes/navigation/NavigationAbstractClass.ts:72
Connects the activity to the class.
Parameters
activity
string | ActivityInterface
The activity to connect to the class.
options?
ActiveScheduling = {}
Returns
void
Implementation of
MapBaseInternalInterface.addActivity
Inherited from
NavigationAbstractClass.addActivity
clearExpiredActivities()
> clearExpiredActivities(): void
Defined in: src/classes/navigation/NavigationAbstractClass.ts:149
Removes the useless activities.
Returns
void
Implementation of
MapBaseInternalInterface.clearExpiredActivities
Inherited from
NavigationAbstractClass.clearExpiredActivities
getStorageProperty()
> protected getStorageProperty<T>(propertyName, idToUse?): T | undefined
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56
Get a property from the storage.
Type Parameters
T
T = StorageElementType
Parameters
propertyName
string
The name of the property to get.
idToUse?
string
The id of the instance to get the property.
Returns
T | undefined
The value of the property. If the property is not found, returns undefined.
Default
this.idImplementation of
MapBaseInternalInterface.getStorageProperty
Inherited from
NavigationAbstractClass.getStorageProperty
migrateOldStorage()
> protected migrateOldStorage(oldCategoryId?): void
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37
Parameters
oldCategoryId?
string
Returns
void
Implementation of
MapBaseInternalInterface.migrateOldStorage
Inherited from
NavigationAbstractClass.migrateOldStorage
removeActivity()
> removeActivity(activity): void
Defined in: src/classes/navigation/NavigationAbstractClass.ts:134
Disconnects the activity from the class.
Parameters
activity
string | ActivityInterface
The activity to disconnect from the class.
Returns
void
Implementation of
MapBaseInternalInterface.removeActivity
Inherited from
NavigationAbstractClass.removeActivity
setStorageProperty()
> protected setStorageProperty<T>(propertyName, value): void
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49
Update a property in the storage.
Type Parameters
T
T
The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)
Parameters
propertyName
string
The name of the property to set.
value
StorageElementType
The value to set. If is undefined, the property will be removed from the storage.
Returns
void
Implementation of
MapBaseInternalInterface.setStorageProperty
Inherited from
NavigationAbstractClass.setStorageProperty