Waze Map Editor JavaScript SDK
    Preparing search index...

    Interface SegmentRestriction

    Represents restrictions applied to a segment.

    interface SegmentRestriction {
        defaultType: null | RESTRICTION_TYPE;
        description: null | string;
        direction: null | RestrictionSegmentDirection;
        disposition: null | RestrictionSegmentLaneScope;
        driveProfiles: VehicleRules;
        editable: boolean;
        isExpired: boolean;
        laneScope: null | RestrictionSegmentLaneScope;
        laneType: null | RestrictionSegmentLaneType;
        timeFrames: TimeFrame[];
        vehicleRules: VehicleRules;
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultType description direction disposition driveProfiles editable isExpired laneScope laneType timeFrames vehicleRules

    Properties

    defaultType: null | RESTRICTION_TYPE

    Default restriction type. Allowed combinations for defaultType and vehicleRules:

    • BLOCKED: vehicleRules can contain FREE rules or be empty.
    • FREE: vehicleRules must contain BLOCKED rules.
    • TOLL: vehicleRules must contain FREE rules.
    description: null | string

    Free text description of the restriction.

    direction: null | RestrictionSegmentDirection

    Traffic direction restricted on the segment.

    disposition: null | RestrictionSegmentLaneScope

    Lane disposition the restriction applies to.

    Use laneScope instead.

    driveProfiles: VehicleRules

    Drive profiles overriding the default restriction per restriction type.

    Use vehicleRules instead.

    editable: boolean

    Whether the restriction is editable by the current user.

    isExpired: boolean

    Whether the restriction has expired based on its time frames.

    laneScope: null | RestrictionSegmentLaneScope

    Lane scope the restriction applies to.

    laneType: null | RestrictionSegmentLaneType

    Specialized lane type (e.g., HOV, bus).

    timeFrames: TimeFrame[]

    Array of time frames indicating when the restriction applies.

    vehicleRules: VehicleRules

    Vehicle rules overriding the default restriction per restriction type.

    Settings

    Member Visibility

    On This Page

    Properties