Class Segment

Hierarchy (View Summary)

FeatureVector<SegmentId, LineString, SegmentAttributes>
- Segment

Index

Constructors

Properties

fid? hidden ALL_PERMISSIONS

Methods

arePropertiesEditable arePropertiesSuggestible areTurnsLocked canEditAverageSpeedCamera canEditClosures canEditConnections canEditDirection canEditHeadlightsReminder canEditHouseNumbers canEditRoutingRoadTypes canForceHouseNumbers canSuggestEditConnections canUserSetDefaultRank changeID clone copyAttributes equals getAddress getAttribute getAttributes getBidiDrivingRestrictions getCenterLonLat getCenterPoint getClonedGeometry getConnectedSegments getConnectedSegmentsByDirection getCreatedBy getCreatedOn getDirection getDrivingRestrictionCount getDrivingRestrictions getEndPoints getFlagAttribute getFlagAttributes getForwardDrivingRestrictions getFromNode getFwdHeading getGeometry getID getIsInBbox getLaneCount getLockRank getNodeAttribute getNodeByDirection getOLGeometry getOtherNode getPathIds getPermissions getPrevID getPrimaryStreetID getRevDirection getReverseDrivingRestrictions getRevHeading getRoadType getState getSuggestionPermissions getToNode getTurnsLockAttribute getType getUniqueID getUniqueIdentifier getUpdatedBy getUpdatedOn getVersion hasBeacons hasClosures hasFromNode hasGeometry hasPaths hasPermissionFlag hasRestrictions hasToNode isAllowed isAllowedForSuggestion isAllowedSuggestingAverageSpeedCamera isAllowedSuggestingDirection isAllowedSuggestingHeadlightsReminder isAllowedSuggestingRoutingRoadTypes isAtoB isBtoA isConnectedToNode isDeleteable isDeleted isDeleteSuggestible isDrivable isGeometryEditable isGeometrySuggestible isHighway isInJunctionBoxRoundabout isInRoundabout isInserted isInUse isLanesEnabled isNew isOneWay isOutOfScope isPoint isSelected isSnapped isTurnAllowed isTwoWay isUnchanged isUpdated isVirtuallyConnectedToNode isWalkingTrail merge resetOutOfScope setAttribute setAttributes setGeometry setID setIsInBboxToTrue setOLGeometry setOutOfScope setSelected setSnapped setState setTunnel setTurnsLock setUnpaved setVersion supportsVirtualNodes wasCreatedBy defaults getArrowPoints

Constructors

constructor

new Segment(
    attributes: Partial<SegmentAttributes> & { geoJSONGeometry: LineString } & {
        id: number;
    },
): Segment
Parameters
- attributes: Partial<SegmentAttributes> & { geoJSONGeometry: LineString } & { id: number }
Returns Segment
Overrides FeatureVector.constructor

Properties

`Optional`fid

hidden

hidden: boolean

`Static`ALL_PERMISSIONS

ALL_PERMISSIONS: number = 0x7fffffff

Methods

arePropertiesEditable

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

arePropertiesSuggestible

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

Returns boolean
Inherited from FeatureVector.arePropertiesSuggestible

areTurnsLocked

areTurnsLocked(node: NodeModel): boolean
Parameters
- node: NodeModel
Returns boolean

canEditAverageSpeedCamera

canEditAverageSpeedCamera(): boolean
Returns boolean

canEditClosures

canEditClosures(): boolean
Returns boolean

canEditConnections

canEditConnections(): boolean
Returns boolean

canEditDirection

canEditDirection(): boolean
Returns boolean

canEditHeadlightsReminder

canEditHeadlightsReminder(): boolean
Returns boolean

canEditHouseNumbers

canEditHouseNumbers(): boolean
Returns boolean

canEditRoutingRoadTypes

canEditRoutingRoadTypes(): boolean
Returns boolean

canForceHouseNumbers

canForceHouseNumbers(): boolean
Returns boolean

canSuggestEditConnections

canSuggestEditConnections(): boolean
Returns boolean

canUserSetDefaultRank

canUserSetDefaultRank(userRank: UserRank): boolean
Parameters
- userRank: UserRank
Returns boolean

changeID

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

clone

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

copyAttributes

copyAttributes(other: Segment): void
Parameters
- other: Segment
Returns void

equals

equals(other: Segment): boolean
Parameters
- other: Segment
Returns boolean

getAddress

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

getAttribute

getAttribute<TAttributeKey extends keyof SegmentAttributes>(
key: TAttributeKey,
): SegmentAttributes[TAttributeKey]
Type Parameters
- TAttributeKey extends keyof SegmentAttributes
Parameters
- key: TAttributeKey
Returns SegmentAttributes[TAttributeKey]
Inherited from FeatureVector.getAttribute

getAttributes

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

getBidiDrivingRestrictions

getBidiDrivingRestrictions(): SegmentRestriction[]
Returns SegmentRestriction[]

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

getClonedGeometry

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

getConnectedSegments

getConnectedSegments(dataModel: DataModel, nodeName: NodeName): Segment[]
Parameters
- dataModel: DataModel
- nodeName: NodeName
Returns Segment[]

getConnectedSegmentsByDirection

getConnectedSegmentsByDirection(
dataModel: DataModel,
direction: NodeName,
): Segment[]
Parameters
- dataModel: DataModel
- direction: NodeName
Returns Segment[]

getCreatedBy

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

getCreatedOn

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

getDirection

getDirection(): DIRECTION
Returns DIRECTION

getDrivingRestrictionCount

getDrivingRestrictionCount(): number
Returns number

getDrivingRestrictions

getDrivingRestrictions(): SegmentRestriction[]
Returns SegmentRestriction[]

getEndPoints

getEndPoints(): [Point, Point]
Returns [Point, Point]

getFlagAttribute

getFlagAttribute(flagName: keyof SegmentFlagAttributes): boolean
Parameters
- flagName: keyof SegmentFlagAttributes
  attribute
Returns boolean
whether the flag is present in the segment (in the bitmask)

getFlagAttributes

getFlagAttributes(): SegmentFlagAttributes
Returns SegmentFlagAttributes

getForwardDrivingRestrictions

getForwardDrivingRestrictions(): SegmentRestriction[]
Returns SegmentRestriction[]

getFromNode

getFromNode(dataModel: DataModel): null | NodeModel
Parameters
- dataModel: DataModel
Returns null | NodeModel

getFwdHeading

getFwdHeading(): number
Returns number

getGeometry

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

getID

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

getIsInBbox

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

getLaneCount

getLaneCount(direction: SEGMENT_LANE_DIRECTION): number
Parameters
- direction: SEGMENT_LANE_DIRECTION
Returns number

getLockRank

getLockRank(): UserRank
Returns UserRank

getNodeAttribute

getNodeAttribute(node: NodeModel): null | NodeName
Parameters
- node: NodeModel
Returns null | NodeName

getNodeByDirection

getNodeByDirection(dataModel: DataModel, direction: NodeName): null | NodeModel
Parameters
- dataModel: DataModel
- direction: NodeName
Returns null | NodeModel

getOLGeometry

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

Inherited from FeatureVector.getOLGeometry

getOtherNode

getOtherNode(dataModel: DataModel, node: NodeModel): null | NodeModel
Parameters
- dataModel: DataModel
- node: NodeModel
Returns null | NodeModel

getPathIds

getPathIds(): number[]
Returns number[]

getPermissions

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

getPrevID

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

getPrimaryStreetID

getPrimaryStreetID(): null | number
Returns null | number

getRevDirection

getRevDirection(): boolean
Returns boolean

getReverseDrivingRestrictions

getReverseDrivingRestrictions(): SegmentRestriction[]
Returns SegmentRestriction[]

getRevHeading

getRevHeading(): number
Returns number

getRoadType

getRoadType(): RoadType
Returns RoadType

getState

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

getSuggestionPermissions

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

getToNode

getToNode(dataModel: DataModel): null | NodeModel
Parameters
- dataModel: DataModel
Returns null | NodeModel

getTurnsLockAttribute

getTurnsLockAttribute(node: NodeModel): "fwdTurnsLocked" | "revTurnsLocked"
Parameters
- node: NodeModel
Returns "fwdTurnsLocked" | "revTurnsLocked"

getType

getType(): DataModelObjectType
Returns DataModelObjectType
Inherited from FeatureVector.getType

getUniqueID

getUniqueID(): ObjectUniqueId
Returns ObjectUniqueId
Inherited from FeatureVector.getUniqueID

getUniqueIdentifier

getUniqueIdentifier(): UniqueObjectIdentifier<number, DataModelObjectType>
Returns UniqueObjectIdentifier<number, DataModelObjectType>
Inherited from FeatureVector.getUniqueIdentifier

getUpdatedBy

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

getUpdatedOn

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

getVersion

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

hasBeacons

hasBeacons(): boolean
Returns boolean

hasClosures

hasClosures(): boolean
Returns boolean

hasFromNode

hasFromNode(): boolean
Returns boolean

hasGeometry

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

hasPaths

hasPaths(): 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

hasRestrictions

hasRestrictions(): boolean
Returns boolean

hasToNode

hasToNode(): 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

isAllowedSuggestingAverageSpeedCamera

isAllowedSuggestingAverageSpeedCamera(): boolean
Returns boolean

isAllowedSuggestingDirection

isAllowedSuggestingDirection(): boolean
Returns boolean

isAllowedSuggestingHeadlightsReminder

isAllowedSuggestingHeadlightsReminder(): boolean
Returns boolean

isAllowedSuggestingRoutingRoadTypes

isAllowedSuggestingRoutingRoadTypes(): boolean
Returns boolean

isAtoB

isAtoB(): boolean
Returns boolean

isBtoA

isBtoA(): boolean
Returns boolean

isConnectedToNode

isConnectedToNode(node: NodeModel): boolean
Parameters
- node: NodeModel
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

isDrivable

isDrivable(): 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

isHighway

isHighway(): boolean
Returns boolean

isInJunctionBoxRoundabout

isInJunctionBoxRoundabout(): boolean
Returns boolean

isInRoundabout

isInRoundabout(): boolean
Returns boolean

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

isLanesEnabled

isLanesEnabled(direction: SEGMENT_LANE_DIRECTION): boolean
Parameters
- direction: SEGMENT_LANE_DIRECTION
Returns boolean

isNew

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

isOneWay

isOneWay(): boolean
Returns boolean

isOutOfScope

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

isPoint

isPoint(): boolean
Returns boolean

isSelected

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

isSnapped

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

isTurnAllowed

isTurnAllowed(
    dataModel: DataModel,
    toSegment: Segment,
    node: NodeModel,
): boolean
Parameters
- dataModel: DataModel
- toSegment: Segment
- node: NodeModel
Returns boolean

isTwoWay

isTwoWay(): boolean
Returns boolean

isUnchanged

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

isUpdated

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

isVirtuallyConnectedToNode

isVirtuallyConnectedToNode(node: NodeModel): boolean
Parameters
- node: NodeModel
Returns boolean

isWalkingTrail

isWalkingTrail(): boolean
Returns boolean

merge

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

resetOutOfScope

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

setAttribute

setAttribute<TAttributeKey extends keyof SegmentAttributes>(
key: TAttributeKey,
value: SegmentAttributes[TAttributeKey],
): void
Type Parameters
- TAttributeKey extends keyof SegmentAttributes
Parameters
- key: TAttributeKey
- value: SegmentAttributes[TAttributeKey]
Returns void
Inherited from FeatureVector.setAttribute

setAttributes

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

setGeometry

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

setID

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

setIsInBboxToTrue

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

setOLGeometry

setOLGeometry(olGeometry: Geometry.LineString): void
Parameters
- olGeometry: Geometry.LineString
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(selected: boolean): void
Parameters
- selected: boolean
Returns void
Overrides 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

setTunnel

setTunnel(isTunnel: boolean): void
Parameters
- isTunnel: boolean
Returns void

setTurnsLock

setTurnsLock(node: NodeModel, lock: boolean): void
Parameters
- node: NodeModel
- lock: boolean
Returns void

setUnpaved

setUnpaved(isUnpaved: boolean): void
Parameters
- isUnpaved: boolean
Returns void

setVersion

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

supportsVirtualNodes

supportsVirtualNodes(): boolean
Returns boolean

wasCreatedBy

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

`Static`defaults

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

`Static`getArrowPoints

getArrowPoints(
    geometry: LineString,
    distanceBetweenArrows: number,
    firstArrowDistance?: number,
    lastArrowDistance?: number,
): ArrowDescriptorTuple[]
Parameters
- geometry: LineString
- distanceBetweenArrows: number
- OptionalfirstArrowDistance: number
- OptionallastArrowDistance: number
Returns ArrowDescriptorTuple[]