Class Venue

Hierarchy (View Summary)

FeatureVector<RuntimeVenueId, VenueGeoJSONGeometry, VenueAttributes>
- Venue

Index

Constructors

Properties

Methods

_defaultCategoryAttributes _mergeCategoryAttributesWithDefault areExternalProvidersEditable arePropertiesEditable arePropertiesSuggestible areUpdateRequestsEditable changeID clone getAddress getAliases getApprovedImages getAttribute getAttributes getBrand getCategories getCategoryAttributes getCategorySet getCenterLonLat getCenterPoint getChargingStationAttributes getClonedGeometry getCreatedBy getCreatedOn getExternalProviderIDs getExternalProviders getGeometry getID getImageById getImages getImagesByUserId getIsInBbox getLockRank getMainCategory getName getNavigationPoints getOLGeometry getOpeningHours getPermissions getPhoneNumber getPointGeometry getPolygonGeometry getPrevID getServices getServiceSet getState getSuggestionPermissions getType getUniqueID getUniqueIdentifier getUpdatedBy getUpdatedOn getUpdateRequests getUrl getVenueUpdateRequests getVersion hasGeometry hasOpenUpdateRequests hasPermissionFlag hasUpdateRequests is2D isAdLocked isAllowed isAllowedForSuggestion isApproved isChargingStation isCrisisLocation isDeleteable isDeleted isDeleteSuggestible isGasStation isGeometryEditable isGeometrySuggestible isInserted isInUse isNaturalFeatures isNew isOutOfScope isParkingLot isPoint isProviderChargingStation isResidential isSelected isSnapped isUnchanged isUpdated merge parseUpdateRequests requiresModeration resetOutOfScope setAttribute setAttributes setGeometry setID setIsInBboxToTrue setOLGeometry setOutOfScope setSelected setSnapped setState setVersion wasCreatedBy defaults fromCategory

Constructors

constructor

new Venue(attributes: PartialVenueAttributes): Venue
Parameters
- attributes: PartialVenueAttributes
Returns Venue
Overrides FeatureVector.constructor

Properties

`Optional`fid

fid?: ObjectId

`Static`ALL_PERMISSIONS

ALL_PERMISSIONS: number = 0x7fffffff

Methods

_defaultCategoryAttributes

_defaultCategoryAttributes(): Partial<
    {
        CAR_SERVICES: {};
        CRISIS_LOCATIONS: {};
        CULTURE_AND_ENTERTAINEMENT: {};
        FOOD_AND_DRINK: {};
        LODGING: {};
        NATURAL_FEATURES: {};
        OTHER: {};
        OUTDOORS: {};
        PARKING_LOT: {};
        PROFESSIONAL_AND_PUBLIC: {};
        SHOPPING_AND_SERVICES: {};
        TRANSPORTATION: {};
    } & {
        CHARGING_STATION: ChargingStationAttributes;
        PARKING_LOT: ParkingAttributesInterface;
    },
>
Returns Partial<
    {
        CAR_SERVICES: {};
        CRISIS_LOCATIONS: {};
        CULTURE_AND_ENTERTAINEMENT: {};
        FOOD_AND_DRINK: {};
        LODGING: {};
        NATURAL_FEATURES: {};
        OTHER: {};
        OUTDOORS: {};
        PARKING_LOT: {};
        PROFESSIONAL_AND_PUBLIC: {};
        SHOPPING_AND_SERVICES: {};
        TRANSPORTATION: {};
    } & {
        CHARGING_STATION: ChargingStationAttributes;
        PARKING_LOT: ParkingAttributesInterface;
    },
>

_mergeCategoryAttributesWithDefault

_mergeCategoryAttributesWithDefault(): void
Returns void

areExternalProvidersEditable

areExternalProvidersEditable(): boolean
Returns boolean

arePropertiesEditable

arePropertiesEditable(): boolean
Returns boolean
Overrides FeatureVector.arePropertiesEditable

arePropertiesSuggestible

arePropertiesSuggestible(): boolean
Whether the current user can suggest a property change for the object

Returns boolean
Inherited from FeatureVector.arePropertiesSuggestible

areUpdateRequestsEditable

areUpdateRequestsEditable(): boolean
Returns boolean

changeID

changeID(newID: RuntimeVenueId): void
Parameters
- newID: RuntimeVenueId
Returns void
Inherited from FeatureVector.changeID

clone

clone(): this
Returns this
Inherited from FeatureVector.clone

getAddress

getAddress(dataModel: DataModel): Address
Parameters
- dataModel: DataModel
Returns Address

getAliases

getAliases(): string[]
Returns string[]

getApprovedImages

getApprovedImages(): VenueImage[]
Returns VenueImage[]

getAttribute

getAttribute<
    TAttributeKey extends
        | "houseNumber"
        | "name"
        | "active"
        | "adLocked"
        | "aliases"
        | "approved"
        | "brand"
        | "categories"
        | "categoryAttributes"
        | "description"
        | "entryExitPoints"
        | "externalProviderIDs"
        | "images"
        | "lockRank"
        | "mergedFrom"
        | "openingHours"
        | "phone"
        | "rank"
        | "residential"
        | "services"
        | "streetID"
        | "url"
        | "venueUpdateRequests"
        | "geoJSONGeometry"
        | (keyof FeatureVectorAttributes<RuntimeVenueId>),
>(
    key: TAttributeKey,
): VenueAttributes[TAttributeKey]
Type Parameters
- TAttributeKey extends
      | "houseNumber"
      | "name"
      | "active"
      | "adLocked"
      | "aliases"
      | "approved"
      | "brand"
      | "categories"
      | "categoryAttributes"
      | "description"
      | "entryExitPoints"
      | "externalProviderIDs"
      | "images"
      | "lockRank"
      | "mergedFrom"
      | "openingHours"
      | "phone"
      | "rank"
      | "residential"
      | "services"
      | "streetID"
      | "url"
      | "venueUpdateRequests"
      | "geoJSONGeometry"
      | (keyof FeatureVectorAttributes<RuntimeVenueId>)
Parameters
- key: TAttributeKey
Returns VenueAttributes[TAttributeKey]
Inherited from FeatureVector.getAttribute

getAttributes

getAttributes(): VenueAttributes
Returns VenueAttributes
Inherited from FeatureVector.getAttributes

getBrand

getBrand(): null | string
Returns null | string

getCategories

getCategories(): VenueCategory[]
Returns VenueCategory[]

getCategoryAttributes

getCategoryAttributes(): Partial<
    {
        CAR_SERVICES: {};
        CRISIS_LOCATIONS: {};
        CULTURE_AND_ENTERTAINEMENT: {};
        FOOD_AND_DRINK: {};
        LODGING: {};
        NATURAL_FEATURES: {};
        OTHER: {};
        OUTDOORS: {};
        PARKING_LOT: {};
        PROFESSIONAL_AND_PUBLIC: {};
        SHOPPING_AND_SERVICES: {};
        TRANSPORTATION: {};
    } & {
        CHARGING_STATION: ChargingStationAttributes;
        PARKING_LOT: ParkingAttributesInterface;
    },
>
Returns Partial<
    {
        CAR_SERVICES: {};
        CRISIS_LOCATIONS: {};
        CULTURE_AND_ENTERTAINEMENT: {};
        FOOD_AND_DRINK: {};
        LODGING: {};
        NATURAL_FEATURES: {};
        OTHER: {};
        OUTDOORS: {};
        PARKING_LOT: {};
        PROFESSIONAL_AND_PUBLIC: {};
        SHOPPING_AND_SERVICES: {};
        TRANSPORTATION: {};
    } & {
        CHARGING_STATION: ChargingStationAttributes;
        PARKING_LOT: ParkingAttributesInterface;
    },
>

getCategorySet

getCategorySet(): Set<VenueCategory>
Returns Set<VenueCategory>

getCenterLonLat

getCenterLonLat(): LonLat
Returns a lonlat of the geometry that can be passed to map methods

Returns LonLat
Inherited from FeatureVector.getCenterLonLat

getCenterPoint

getCenterPoint(): Point
Returns a center point of the geometry. If the geometry is not a LineString returns an absolute center. Otherwise, returns the nearest point on a line to an absolute center

Returns Point
Inherited from FeatureVector.getCenterPoint

getChargingStationAttributes

getChargingStationAttributes(): null | ChargingStationAttributes
Returns null | ChargingStationAttributes

getClonedGeometry

getClonedGeometry(): VenueGeoJSONGeometry
Returns VenueGeoJSONGeometry
Inherited from FeatureVector.getClonedGeometry

getCreatedBy

getCreatedBy(): number
Returns number
Inherited from FeatureVector.getCreatedBy

getCreatedOn

getCreatedOn(): number
Returns number
Inherited from FeatureVector.getCreatedOn

getExternalProviderIDs

getExternalProviderIDs(): ExternalProvider[]
Returns ExternalProvider[]

getExternalProviders

getExternalProviders(): ExternalProvider[]
Returns ExternalProvider[]

getGeometry

getGeometry(): VenueGeoJSONGeometry
Returns VenueGeoJSONGeometry
Inherited from FeatureVector.getGeometry

getID

getID(): string
Returns string
Overrides FeatureVector.getID

getImageById

getImageById(id: ObjectId): undefined | VenueImage
Parameters
- id: ObjectId
Returns undefined | VenueImage

getImages

getImages(): VenueImage[]
Returns VenueImage[]

getImagesByUserId

getImagesByUserId(userId: number): VenueImage[]
Parameters
- userId: number
Returns VenueImage[]

getIsInBbox

getIsInBbox(): boolean
Returns boolean
Inherited from FeatureVector.getIsInBbox

getLockRank

getLockRank(): number
Returns number

getMainCategory

getMainCategory(): VenueMainCategory
Returns VenueMainCategory

getName

getName(): string
Returns string

getNavigationPoints

getNavigationPoints(): NavigationPoint[]
Returns NavigationPoint[]

getOLGeometry

getOLGeometry(): Point | Polygon
Returns Point | Polygon
Deprecated
The OpenLayers.Geometry is deprecated, please use the GeoJSON getGeometry() instead.

Inherited from FeatureVector.getOLGeometry

getOpeningHours

getOpeningHours(): OpeningHour[]
Returns OpeningHour[]

getPermissions

getPermissions(): number
Returns number
Inherited from FeatureVector.getPermissions

getPhoneNumber

getPhoneNumber(): string
Returns string

getPointGeometry

getPointGeometry(): Point
Returns Point

getPolygonGeometry

getPolygonGeometry(): Polygon
Returns Polygon

getPrevID

getPrevID(): null | RuntimeVenueId
Returns null | RuntimeVenueId
Inherited from FeatureVector.getPrevID

getServices

getServices(): ServiceType[]
Returns ServiceType[]

getServiceSet

getServiceSet(): Set<ServiceType>
Returns Set<ServiceType>

getState

getState(): null | OBJECT_STATE
Returns null | OBJECT_STATE
Inherited from FeatureVector.getState

getSuggestionPermissions

getSuggestionPermissions(): number
Returns number
Inherited from FeatureVector.getSuggestionPermissions

getUpdatedBy

getUpdatedBy(): number
Returns number
Inherited from FeatureVector.getUpdatedBy

getUpdatedOn

getUpdatedOn(): number
Returns number
Inherited from FeatureVector.getUpdatedOn

getUpdateRequests

getUpdateRequests(): PlaceUpdate<PlaceUpdateAttributes>[]
Returns PlaceUpdate<PlaceUpdateAttributes>[]

getUrl

getUrl(): string
Returns string

getVenueUpdateRequests

getVenueUpdateRequests(): PlaceUpdate<PlaceUpdateAttributes>[]
Returns PlaceUpdate<PlaceUpdateAttributes>[]

getVersion

getVersion(): undefined | number
Returns undefined | number
Inherited from FeatureVector.getVersion

hasGeometry

hasGeometry(): boolean
Returns boolean
Inherited from FeatureVector.hasGeometry

hasOpenUpdateRequests

hasOpenUpdateRequests(): boolean
Returns boolean

hasPermissionFlag

hasPermissionFlag(
    key:
        | "NO_PERMISSION"
        | "EDIT_GEOMETRY"
        | "EDIT_PROPERTIES"
        | "DELETE"
        | "EDIT_EMPTY_STREET"
        | "SPLIT_DIRECTIONS"
        | "SET_UNKNOWN_DIRECTIONS"
        | "EDIT_HOUSE_NUMBERS"
        | "FORCE_HOUSE_NUMBERS"
        | "EDIT_CONNECTIONS"
        | "EDIT_ROUTING_ROAD_TYPE"
        | "EDIT_CLOSURES"
        | "EDIT_HEADLIGHTS_REMINDER"
        | "EDIT_AVERAGE_SPEED_CAMERA"
        | "EDIT_BEACONS"
        | "EDIT_DIRECTIONS"
        | "EDIT_TURN_GUIDANCE"
        | "EDIT_OPEN_TURNS"
        | "EDIT_CLOSE_TURNS"
        | "EDIT"
        | "FORCE_CLOSE"
        | "PUBLISH"
        | "SET_READY"
        | "EDIT_UPDATE_REQUESTS"
        | "EDIT_EXTERNAL_PROVIDERS",
): boolean
Parameters
- key:
      | "NO_PERMISSION"
      | "EDIT_GEOMETRY"
      | "EDIT_PROPERTIES"
      | "DELETE"
      | "EDIT_EMPTY_STREET"
      | "SPLIT_DIRECTIONS"
      | "SET_UNKNOWN_DIRECTIONS"
      | "EDIT_HOUSE_NUMBERS"
      | "FORCE_HOUSE_NUMBERS"
      | "EDIT_CONNECTIONS"
      | "EDIT_ROUTING_ROAD_TYPE"
      | "EDIT_CLOSURES"
      | "EDIT_HEADLIGHTS_REMINDER"
      | "EDIT_AVERAGE_SPEED_CAMERA"
      | "EDIT_BEACONS"
      | "EDIT_DIRECTIONS"
      | "EDIT_TURN_GUIDANCE"
      | "EDIT_OPEN_TURNS"
      | "EDIT_CLOSE_TURNS"
      | "EDIT"
      | "FORCE_CLOSE"
      | "PUBLISH"
      | "SET_READY"
      | "EDIT_UPDATE_REQUESTS"
      | "EDIT_EXTERNAL_PROVIDERS"
Returns boolean
Inherited from FeatureVector.hasPermissionFlag

hasUpdateRequests

hasUpdateRequests(): boolean
Returns boolean

is2D

is2D(): boolean
Returns boolean

isAdLocked

isAdLocked(): boolean
Returns boolean

isAllowed

isAllowed(permission: number): boolean
Parameters
- permission: number
Returns boolean
Inherited from FeatureVector.isAllowed

isAllowedForSuggestion

isAllowedForSuggestion(suggestionPermission: number): boolean
Parameters
- suggestionPermission: number
Returns boolean
Inherited from FeatureVector.isAllowedForSuggestion

isApproved

isApproved(): boolean
Returns boolean

isChargingStation

isChargingStation(): boolean
Returns boolean

isCrisisLocation

isCrisisLocation(): boolean
Returns boolean

isDeleteable

isDeleteable(): boolean
Returns boolean
Inherited from FeatureVector.isDeleteable

isDeleted

isDeleted(): boolean
Returns boolean
Inherited from FeatureVector.isDeleted

isDeleteSuggestible

isDeleteSuggestible(): boolean
Returns boolean
Inherited from FeatureVector.isDeleteSuggestible

isGasStation

isGasStation(): boolean
Returns boolean

isGeometryEditable

isGeometryEditable(): boolean
Returns boolean
Inherited from FeatureVector.isGeometryEditable

isGeometrySuggestible

isGeometrySuggestible(): boolean
Whether the current user can suggest a geometry change for the object

Returns boolean
Inherited from FeatureVector.isGeometrySuggestible

isInserted

isInserted(): boolean
Returns boolean
Inherited from FeatureVector.isInserted

isInUse

isInUse(
options?: { keepSelected?: boolean; keepUnsaved?: boolean },
): undefined | boolean
Returns true if object is currently in use and should not be deleted.
Parameters
- options: { keepSelected?: boolean; keepUnsaved?: boolean } = ...
  See DataModelRepository.clear for available options
Returns undefined | boolean
true if object is in use

Inherited from FeatureVector.isInUse

isNaturalFeatures

isNaturalFeatures(): boolean
Returns boolean

isNew

isNew(): boolean
Returns boolean
Inherited from FeatureVector.isNew

isOutOfScope

isOutOfScope(): boolean
Returns boolean
Inherited from FeatureVector.isOutOfScope

isParkingLot

isParkingLot(): boolean
Returns boolean

isPoint

isPoint(): boolean
Returns boolean

isProviderChargingStation

isProviderChargingStation(): boolean
Returns boolean

isResidential

isResidential(): boolean
Returns boolean

isSelected

isSelected(): boolean
Returns boolean
Inherited from FeatureVector.isSelected

isSnapped

isSnapped(): boolean
Returns boolean
Inherited from FeatureVector.isSnapped

isUnchanged

isUnchanged(): boolean
Returns boolean
Inherited from FeatureVector.isUnchanged

isUpdated

isUpdated(): boolean
Returns boolean
Inherited from FeatureVector.isUpdated

merge

merge(attributes: PartialVenueAttributes): void
Parameters
- attributes: PartialVenueAttributes
Returns void
Overrides FeatureVector.merge

parseUpdateRequests

parseUpdateRequests(attributes: PartialVenueAttributes): void
Parameters
- attributes: PartialVenueAttributes
Returns void

requiresModeration

requiresModeration(): boolean
Returns boolean

resetOutOfScope

resetOutOfScope(): void
Returns void
Inherited from FeatureVector.resetOutOfScope

setAttribute

setAttribute<
    TAttributeKey extends
        | "houseNumber"
        | "name"
        | "active"
        | "adLocked"
        | "aliases"
        | "approved"
        | "brand"
        | "categories"
        | "categoryAttributes"
        | "description"
        | "entryExitPoints"
        | "externalProviderIDs"
        | "images"
        | "lockRank"
        | "mergedFrom"
        | "openingHours"
        | "phone"
        | "rank"
        | "residential"
        | "services"
        | "streetID"
        | "url"
        | "venueUpdateRequests"
        | "geoJSONGeometry"
        | (keyof FeatureVectorAttributes<RuntimeVenueId>),
>(
    key: TAttributeKey,
    value: VenueAttributes[TAttributeKey],
): void
Type Parameters
- TAttributeKey extends
      | "houseNumber"
      | "name"
      | "active"
      | "adLocked"
      | "aliases"
      | "approved"
      | "brand"
      | "categories"
      | "categoryAttributes"
      | "description"
      | "entryExitPoints"
      | "externalProviderIDs"
      | "images"
      | "lockRank"
      | "mergedFrom"
      | "openingHours"
      | "phone"
      | "rank"
      | "residential"
      | "services"
      | "streetID"
      | "url"
      | "venueUpdateRequests"
      | "geoJSONGeometry"
      | (keyof FeatureVectorAttributes<RuntimeVenueId>)
Parameters
- key: TAttributeKey
- value: VenueAttributes[TAttributeKey]
Returns void
Inherited from FeatureVector.setAttribute

setAttributes

setAttributes(attributes: Partial<VenueAttributes>): void
Parameters
- attributes: Partial<VenueAttributes>
Returns void
Inherited from FeatureVector.setAttributes

setGeometry

setGeometry(geometry?: VenueGeoJSONGeometry): void
Parameters
- Optionalgeometry: VenueGeoJSONGeometry
Returns void
Inherited from FeatureVector.setGeometry

setID

setID(id: RuntimeVenueId): void
Parameters
- id: RuntimeVenueId
Returns void
Inherited from FeatureVector.setID

setIsInBboxToTrue

setIsInBboxToTrue(): void
Returns void
Inherited from FeatureVector.setIsInBboxToTrue

setOLGeometry

setOLGeometry(olGeometry: Point | Polygon): void
Parameters
- olGeometry: Point | Polygon
Returns void
Deprecated
The OpenLayers.Geometry is deprecated, please use the GeoJSON setGeometry() instead.

Inherited from FeatureVector.setOLGeometry

setOutOfScope

setOutOfScope(): void
Returns void
Inherited from FeatureVector.setOutOfScope

setSelected

setSelected(isSelected: boolean): void
Parameters
- isSelected: boolean
Returns void
Inherited from FeatureVector.setSelected

setSnapped

setSnapped(isSnapped: boolean): void
Parameters
- isSnapped: boolean
Returns void
Inherited from FeatureVector.setSnapped

setState

setState(state: null | OBJECT_STATE): void
Parameters
- state: null | OBJECT_STATE
Returns void
Inherited from FeatureVector.setState

setVersion

setVersion(version: number): void
Parameters
- version: number
Returns void
Inherited from FeatureVector.setVersion

wasCreatedBy

wasCreatedBy(user: User | LoggedInUser): boolean
Parameters
- user: User | LoggedInUser
Returns boolean
Inherited from FeatureVector.wasCreatedBy

`Static`defaults

defaults(): Omit<VenueAttributes, "id" | "geoJSONGeometry">
Returns Omit<VenueAttributes, "id" | "geoJSONGeometry">

`Static`fromCategory

fromCategory(category: VenueCategory, attributes: PartialVenueAttributes): Venue
Parameters
- category: VenueCategory
- attributes: PartialVenueAttributes
Returns Venue

Class Venue

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Venue

Properties

Optionalfid

StaticALL_PERMISSIONS

Methods

_defaultCategoryAttributes

_mergeCategoryAttributesWithDefault

Returns void

areExternalProvidersEditable

Returns boolean

arePropertiesEditable

Returns boolean

arePropertiesSuggestible

Returns boolean

areUpdateRequestsEditable

Returns boolean

changeID

Parameters

Returns void

clone

Returns this

getAddress

Parameters

Returns Address

getAliases

Returns string[]

getApprovedImages

Returns VenueImage[]

getAttribute

Type Parameters

Parameters

Returns VenueAttributes[TAttributeKey]

getAttributes

Returns VenueAttributes

getBrand

Returns null | string

getCategories

Returns VenueCategory[]

getCategoryAttributes

getCategorySet

Returns Set<VenueCategory>

getCenterLonLat

Returns LonLat

getCenterPoint

Returns Point

getChargingStationAttributes

Returns null | ChargingStationAttributes

getClonedGeometry

Returns VenueGeoJSONGeometry

getCreatedBy

Returns number

getCreatedOn

Returns number

getExternalProviderIDs

Returns ExternalProvider[]

getExternalProviders

Returns ExternalProvider[]

getGeometry

Returns VenueGeoJSONGeometry

getID

Returns string

getImageById

Parameters

Returns undefined | VenueImage

getImages

Returns VenueImage[]

getImagesByUserId

Parameters

Returns VenueImage[]

getIsInBbox

Returns boolean

`Optional`fid

`Static`ALL_PERMISSIONS