Waze Map Editor JavaScript SDK
    Preparing search index...

    Interface SegmentRestriction

    Represents restrictions applied to a segment.

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

    Hierarchy (View Summary)

    Index
    defaultType description direction disposition driveProfiles editable isExpired laneScope laneType timeFrames vehicleRules
    defaultType: RESTRICTION_TYPE | null

    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: string | null

    Free text description of the restriction.

    direction: RestrictionSegmentDirection | null

    Traffic direction restricted on the segment.

    disposition: RestrictionSegmentLaneScope | null

    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: RestrictionSegmentLaneScope | null

    Lane scope the restriction applies to.

    laneType: RestrictionSegmentLaneType | null

    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