From 924e0b8710998a578a8c20dd962f9e009cf3ac92 Mon Sep 17 00:00:00 2001 From: smellyshovel Date: Wed, 18 Oct 2023 22:29:59 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20maplibre?= =?UTF-8?q?/maplibre-gl-directions@fd64cf5044927548dbb3f13a3a3dd1cc6a48819?= =?UTF-8?q?e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/classes/BearingsControl.html | 20 +-- api/classes/LoadingIndicatorControl.html | 20 +-- .../MapLibreGlDirectionsRoutingEvent.html | 18 +-- .../MapLibreGlDirectionsWaypointEvent.html | 18 +-- api/classes/MapMouseEvent.html | 6 +- api/classes/MapTouchEvent.html | 6 +- api/classes/default.html | 130 +++++++++--------- api/functions/layersFactory.html | 8 +- api/functions/utils.buildConfiguration.html | 8 +- api/functions/utils.buildPoint.html | 8 +- api/functions/utils.buildRequest.html | 8 +- api/functions/utils.buildRoutelines.html | 8 +- api/functions/utils.buildSnaplines.html | 8 +- api/index.html | 8 +- .../BearingsControlConfiguration.html | 34 ++--- api/interfaces/Directions.html | 16 +-- api/interfaces/Feature.html | 6 +- api/interfaces/Leg.html | 10 +- api/interfaces/LineString.html | 6 +- .../LoadingIndicatorControlConfiguration.html | 14 +- .../MapLibreGlDirectionsConfiguration.html | 40 +++--- .../MapLibreGlDirectionsEventType.html | 22 +-- ...MapLibreGlDirectionsWaypointEventData.html | 12 +- api/interfaces/Point.html | 6 +- api/interfaces/Route.html | 12 +- api/interfaces/Snappoint.html | 10 +- api/modules.html | 8 +- api/modules/utils.html | 8 +- api/types/LayerSpecification.html | 6 +- .../MapLibreGlDirectionsRoutingEventData.html | 8 +- api/types/PointType.html | 8 +- 31 files changed, 250 insertions(+), 250 deletions(-) diff --git a/api/classes/BearingsControl.html b/api/classes/BearingsControl.html index 9efe2176..bfc457a1 100644 --- a/api/classes/BearingsControl.html +++ b/api/classes/BearingsControl.html @@ -1,4 +1,4 @@ -BearingsControl | @maplibre/maplibre-gl-directions - v0.4.2
+BearingsControl | @maplibre/maplibre-gl-directions - v0.4.3
  • Preparing search index...
  • -
  • The search index is not available
@maplibre/maplibre-gl-directions - v0.4.2
+
  • The search index is not available
  • @maplibre/maplibre-gl-directions - v0.4.3
    @@ -32,7 +32,7 @@

    Implements

    • IControl
    +
  • Defined in src/controls/bearings/main.ts:17
  • @@ -69,24 +69,24 @@
    directions: Optional configuration: Partial<BearingsControlConfiguration>

    Returns BearingsControl

    +
  • Defined in src/controls/bearings/main.ts:18
  • Properties

    +
  • Defined in src/controls/bearings/main.ts:25
  • controlElement: HTMLElement
    +
  • Defined in src/controls/bearings/main.ts:23
  • directions: default
    +
  • Defined in src/controls/bearings/main.ts:24
  • Methods

    @@ -98,7 +98,7 @@

    Returns HTMLElem

    +
  • Defined in src/controls/bearings/main.ts:30
    • @@ -108,7 +108,7 @@

      Returns void

    +
  • Defined in src/controls/bearings/main.ts:47
  • Returns LoadingIndicatorControl

    +
  • Defined in src/controls/loading-indicator/main.ts:18
  • Properties

    +
  • Defined in src/controls/loading-indicator/main.ts:25
  • controlElement: HTMLElement
    +
  • Defined in src/controls/loading-indicator/main.ts:23
  • directions: default
    +
  • Defined in src/controls/loading-indicator/main.ts:24
  • Methods

    @@ -98,7 +98,7 @@

    Returns HTMLElem

    +
  • Defined in src/controls/loading-indicator/main.ts:30
    • @@ -108,7 +108,7 @@

      Returns void

    +
  • Defined in src/controls/loading-indicator/main.ts:47
  • @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in src/directions/events.ts:142
  • @@ -60,7 +60,7 @@
    Optional Returns MapLibreGlDirectionsRoutingEvent
    +
  • Defined in src/directions/events.ts:146
  • Properties

    @@ -74,25 +74,25 @@

    http://project-osrm.org/docs/v5.24.0/api/#responses

    +
  • Defined in src/directions/events.ts:167
  • +
  • Defined in src/directions/events.ts:158
  • target: Map
    +
  • Defined in src/directions/events.ts:157
  • type: any
    +
  • Defined in src/directions/events.ts:156
  • @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in src/directions/events.ts:118
  • @@ -60,32 +60,32 @@
    Optional Returns MapLibreGlDirectionsWaypointEvent
    +
  • Defined in src/directions/events.ts:124
  • Properties

    +
  • Defined in src/directions/events.ts:137
  • originalEvent: MapMouseEvent | MapTouchEvent
    +
  • Defined in src/directions/events.ts:136
  • target: Map
    +
  • Defined in src/directions/events.ts:135
  • type: any
    +
  • Defined in src/directions/events.ts:134
  • @@ -188,7 +188,7 @@

    defaultPrevented
  • preventDefault
  • @@ -207,7 +207,7 @@

    defaultPrevented
  • preventDefault
  • @@ -26,7 +26,7 @@

    Hierarchy

    • default
    +
  • Defined in src/directions/main.ts:14
  • @@ -119,19 +119,19 @@
    Optional Returns default
    +
  • Defined in src/directions/main.ts:15
  • Properties

    _interactive: boolean = false
    +
  • Defined in src/directions/main.ts:42
  • _waypoints: Feature<Point, {
        [name: string]: any;
    }>[] = []
    +
  • Defined in src/directions/main.ts:55
  • abortController: AbortController
    @@ -143,7 +143,7 @@

    Example

    direсtions
     
    +
  • Defined in src/directions/main.ts:984
  • buildPoint: ((coordinate, type, properties?) => Feature<Point>) = buildPoint
    @@ -169,7 +169,7 @@
    Optional Returns Feature<Point>
    +
  • Defined in src/directions/main.ts:44
  • buildRequest: ((configuration, waypointsCoordinates, waypointsBearings?) => {
        method: "get" | "post";
        payload: URLSearchParams;
        url: string;
    }) = buildRequest
    @@ -202,7 +202,7 @@
    payloadurl: string
    +
  • Defined in src/directions/main.ts:43
  • buildRoutelines: ((requestOptions, routes, selectedRouteIndex, snappoints) => Feature<LineString>[][]) = buildRoutelines
    @@ -232,7 +232,7 @@
    snappoints: Returns Feature<LineString>[][]
    +
  • Defined in src/directions/main.ts:46
  • buildSnaplines: ((waypointsCoordinates, snappointsCoordinates, hoverpointCoordinates, departSnappointIndex, showHoverpointSnaplines?) => Feature<LineString>[]) = buildSnaplines
    @@ -262,12 +262,12 @@
    showHoverpointSnaplines: Returns Feature<LineString>[]
    +
  • Defined in src/directions/main.ts:45
  • +
  • Defined in src/directions/main.ts:40
  • currentMousePosition: {
        x: number;
        y: number;
    } = ...
    @@ -279,12 +279,12 @@
    x:
  • y: number
  • +
  • Defined in src/directions/main.ts:388
  • departSnappointIndex: number = -1
    +
  • Defined in src/directions/main.ts:387
  • dragDownPosition: {
        x: number;
        y: number;
    } = ...
    @@ -296,17 +296,17 @@
    x:
  • y: number
  • +
  • Defined in src/directions/main.ts:381
  • highlightedSnappoints: Feature<Point, {
        [name: string]: any;
    }>[] = []
    +
  • Defined in src/directions/main.ts:226
  • highlightedWaypoints: Feature<Point, {
        [name: string]: any;
    }>[] = []
    +
  • Defined in src/directions/main.ts:225
  • hoverpoint: Feature<Point, {
        [name: string]: any;
    }> = undefined
    @@ -316,7 +316,7 @@

    Type declaration

  • [name: string]: any
  • +
  • Defined in src/directions/main.ts:59
  • lastRequestMousePosition: {
        x: number;
        y: number;
    } = ...
    @@ -328,7 +328,7 @@
    x:
  • y: number
  • +
  • Defined in src/directions/main.ts:661
  • liveRefreshHandler: ((e) => void)
    @@ -346,18 +346,18 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:53
  • map: Map
    +
  • Defined in src/directions/main.ts:39
  • noMouseMovementTimer: number
    +
  • Defined in src/directions/main.ts:551
  • onClickHandler: ((e) => void)
    @@ -375,7 +375,7 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:52
  • onDragDownHandler: ((e) => void)
    @@ -393,7 +393,7 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:49
  • onDragMoveHandler: ((e) => void)
    @@ -411,7 +411,7 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:50
  • onDragUpHandler: ((e) => void)
    @@ -429,7 +429,7 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:51
  • onMoveHandler: ((e) => void)
    @@ -447,27 +447,27 @@

    Parameters

    e: MapMouseEvent | MapTouchEvent

    Returns void

    +
  • Defined in src/directions/main.ts:48
  • refreshOnMoveIsRefreshing: boolean = false
    +
  • Defined in src/directions/main.ts:508
  • routelines: Feature<LineString, {
        [name: string]: any;
    }>[][] = []
    +
  • Defined in src/directions/main.ts:57
  • selectedRouteIndex: number = 0
    +
  • Defined in src/directions/main.ts:58
  • snappoints: Feature<Point, {
        [name: string]: any;
    }>[] = []
    +
  • Defined in src/directions/main.ts:56
  • waypointBeingDragged?: Feature<Point, {
        [name: string]: any;
    }>
    @@ -477,12 +477,12 @@

    Type declaration

  • [name: string]: any
  • +
  • Defined in src/directions/main.ts:385
  • waypointBeingDraggedInitialCoordinates?: [number, number]
    +
  • Defined in src/directions/main.ts:386
  • Accessors

    @@ -497,7 +497,7 @@
    +
  • Defined in src/directions/main.ts:835
  • set interactive(interactive): void
  • @@ -507,7 +507,7 @@

    Parameters

    interactive: boolean
  • Returns void

    +
  • Defined in src/directions/main.ts:839
  • +
  • Defined in src/directions/main.ts:78
  • +
  • Defined in src/directions/main.ts:72
  • set waypoints(waypoints): void
  • @@ -547,7 +547,7 @@

    Returns voidAlias

    Synchronous analogue of setWaypoints.

  • +
  • Defined in src/directions/main.ts:867
  • set waypointsBearings(bearings): void
  • Sets the waypoints' bearings values. Does not produce any effect in case the bearings configuration option is @@ -573,7 +573,7 @@

    bearings: Returns void
  • +
  • Defined in src/directions/main.ts:894
  • +
  • Defined in src/directions/main.ts:66
  • Methods

    @@ -604,7 +604,7 @@
    Optional Optional originalEvent: MapMouseEvent | MapTouchEvent

    Returns Promise<void>

    +
  • Defined in src/directions/main.ts:767
  • Returns Promise<void>

    +
  • Defined in src/directions/main.ts:806
  • +
  • Defined in src/directions/main.ts:960
  • +
  • Defined in src/directions/main.ts:756
  • +
  • Defined in src/directions/main.ts:989
  • +
  • Defined in src/directions/main.ts:228
  • +
  • Defined in src/directions/main.ts:998
    • @@ -696,7 +696,7 @@

      Parameters

      skipSelectedRouteRedraw: boolean = true

    Returns void

    +
  • Defined in src/directions/main.ts:185
  • Returns Promise<void>

    +
  • Defined in src/directions/main.ts:102
  • +
  • Defined in src/directions/events.ts:14
  • +
  • Defined in src/directions/main.ts:88
  • Returns Promise<void>

    +
  • Defined in src/directions/main.ts:666
  • +
  • Defined in src/directions/events.ts:36
  • +
  • Defined in src/directions/events.ts:29
  • Returns void

    +
  • Defined in src/directions/main.ts:700
  • Returns void

    +
  • Defined in src/directions/main.ts:393
  • Returns void

    +
  • Defined in src/directions/main.ts:510
  • Returns Promise<void>

    +
  • Defined in src/directions/main.ts:553
  • Returns void

    +
  • Defined in src/directions/main.ts:250
  • +
  • Defined in src/directions/events.ts:44
  • +
  • Defined in src/directions/main.ts:970
  • +
  • Defined in src/directions/main.ts:924
  • @@ -43,7 +43,7 @@
    sourceName: Returns LayerSpecification[]
    +
  • Defined in src/directions/layers.ts:12
  • @@ -31,7 +31,7 @@
    Optional Returns MapLibreGlDirectionsConfiguration
    +
  • Defined in src/directions/utils.ts:14
  • @@ -35,7 +35,7 @@
    Optional Returns Feature<Point>
    +
  • Defined in src/directions/utils.ts:97
  • @@ -42,7 +42,7 @@
    payloadurl: string
    +
  • Defined in src/directions/utils.ts:31
  • @@ -39,7 +39,7 @@
    snappoints: Returns Feature<LineString>[][]
    +
  • Defined in src/directions/utils.ts:189
  • @@ -39,7 +39,7 @@
    showHoverpointSnaplines: Returns Feature<LineString>[]
    +
  • Defined in src/directions/utils.ts:122
  • -

    @maplibre/maplibre-gl-directions - v0.4.2

    +

    @maplibre/maplibre-gl-directions - v0.4.3

    MapLibreGlDirections

    For the sakes of your convenience, make sure you've enabled the "Inherited" filter only:

    Enabling the "Inherited" filter only


    @@ -160,7 +160,7 @@

    Visual-only customization
  • Behavioral customization
  • @@ -20,7 +20,7 @@

    Hierarchy

    • BearingsControlConfiguration
    +
  • Defined in src/controls/bearings/types.ts:1
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/controls/bearings/types.ts:21
  • angleMax: number
    @@ -63,7 +63,7 @@

    359

    +
  • Defined in src/controls/bearings/types.ts:35
  • angleMin: number
    @@ -73,7 +73,7 @@

    0

    +
  • Defined in src/controls/bearings/types.ts:28
  • angleStep: number
    @@ -84,7 +84,7 @@

    1

    +
  • Defined in src/controls/bearings/types.ts:43
  • debounceTimeout: number
    @@ -94,7 +94,7 @@
    +
  • Defined in src/controls/bearings/types.ts:14
  • defaultEnabled: boolean
    @@ -104,7 +104,7 @@
    +
  • Defined in src/controls/bearings/types.ts:7
  • degreesDefault: number
    @@ -114,7 +114,7 @@
    +
  • Defined in src/controls/bearings/types.ts:58
  • degreesMax: number
    @@ -124,7 +124,7 @@

    360

    +
  • Defined in src/controls/bearings/types.ts:72
  • degreesMin: number
    @@ -134,7 +134,7 @@

    15

    +
  • Defined in src/controls/bearings/types.ts:65
  • degreesStep: number
    @@ -145,7 +145,7 @@

    15

    +
  • Defined in src/controls/bearings/types.ts:80
  • fixedDegrees: number
    @@ -156,7 +156,7 @@
    +
  • Defined in src/controls/bearings/types.ts:51
  • imageSize: number
    @@ -166,7 +166,7 @@

    50

    +
  • Defined in src/controls/bearings/types.ts:94
  • respectMapBearing: boolean
    @@ -176,7 +176,7 @@
    +
  • Defined in src/controls/bearings/types.ts:87
  • @@ -20,7 +20,7 @@

    Hierarchy

    • Directions
    +
  • Defined in src/directions/types.ts:322
  • @@ -39,22 +39,22 @@

    Properties

    code: string
    +
  • Defined in src/directions/types.ts:323
  • message?: string
    +
  • Defined in src/directions/types.ts:324
  • routes: Route[]
    +
  • Defined in src/directions/types.ts:325
  • waypoints: Snappoint[]
    +
  • Defined in src/directions/types.ts:326
  • @@ -120,7 +120,7 @@

    properties
  • type
  • @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [P: string]: unknown
    +
  • Defined in src/directions/types.ts:341
  • @@ -46,7 +46,7 @@
    Optional
    Optional congestion_numeric?: number[]
    +
  • Defined in src/directions/types.ts:343
  • @@ -89,7 +89,7 @@

    coordinates
  • type
  • @@ -20,7 +20,7 @@

    Hierarchy

    • LoadingIndicatorControlConfiguration
    +
  • Defined in src/controls/loading-indicator/types.ts:1
  • @@ -44,7 +44,7 @@

    Default

    ""
    +
  • Defined in src/controls/loading-indicator/types.ts:21
  • fill: string
    @@ -55,7 +55,7 @@

    Default

    "#6d26d7&
     
    +
  • Defined in src/controls/loading-indicator/types.ts:7
  • size: string
    @@ -66,7 +66,7 @@

    Default

    "24px&quo
     
    +
  • Defined in src/controls/loading-indicator/types.ts:14
  • @@ -24,7 +24,7 @@

    Hierarchy

    • MapLibreGlDirectionsConfiguration
    +
  • Defined in src/directions/types.ts:6
  • @@ -69,7 +69,7 @@

    Example

    api: 
    +
  • Defined in src/directions/types.ts:26
  • bearings: boolean
    @@ -87,7 +87,7 @@

    Example

    // enable the bearings support
    +
  • Defined in src/directions/types.ts:297
  • dragThreshold: number
    @@ -102,7 +102,7 @@

    Example

    // Don't respect drag-events w
     
    +
  • Defined in src/directions/types.ts:268
  • @@ -124,7 +124,7 @@

    Example

    // Use the default layers with all
     
    +
  • Defined in src/directions/types.ts:155
  • linesScalingFactor: number
    @@ -140,7 +140,7 @@

    Example

    // Increase all the lines by 2 tim
     
    +
  • Defined in src/directions/types.ts:189
  • makePostRequest: boolean
    @@ -155,7 +155,7 @@

    Example

    api: 
    +
  • Defined in src/directions/types.ts:108
  • pointsScalingFactor: number
    @@ -170,7 +170,7 @@

    Example

    // Increase all the points by 1.5
     
    +
  • Defined in src/directions/types.ts:171
  • profile: string
    @@ -191,7 +191,7 @@

    Example

    api: 
    +
  • Defined in src/directions/types.ts:48
  • refreshOnMove: boolean
    @@ -204,7 +204,7 @@

    Example

    // make the route update while dra
     
    +
  • Defined in src/directions/types.ts:281
  • requestOptions: Partial<Record<string, string>>
    @@ -223,7 +223,7 @@

    Example

    api: 
    +
  • Defined in src/directions/types.ts:78
  • requestTimeout: number
    @@ -236,7 +236,7 @@

    Example

    // abort requests that take longer
     
    +
  • Defined in src/directions/types.ts:91
  • sensitiveAltRoutelineLayers: string[]
    @@ -249,7 +249,7 @@

    Example

    sensitiveAltRoutelineLayers
     
    +
  • Defined in src/directions/types.ts:253
  • sensitiveRoutelineLayers: string[]
    @@ -262,7 +262,7 @@

    Example

    sensitiveRoutelineLayers
    +
  • Defined in src/directions/types.ts:237
  • sensitiveSnappointLayers: string[]
    @@ -275,7 +275,7 @@

    Example

    sensitiveSnappointLayers
    +
  • Defined in src/directions/types.ts:221
  • sensitiveWaypointLayers: string[]
    @@ -288,7 +288,7 @@

    Example

    sensitiveSnappointLayers
    +
  • Defined in src/directions/types.ts:205
  • sourceName: string
    @@ -304,7 +304,7 @@

    Example

    sourceName
     
    +
  • Defined in src/directions/types.ts:124
  • @@ -24,7 +24,7 @@

    Hierarchy

    • MapLibreGlDirectionsEventType
    +
  • Defined in src/directions/events.ts:55
  • @@ -49,7 +49,7 @@
    +
  • Defined in src/directions/events.ts:70
  • @@ -57,7 +57,7 @@
    +
  • Defined in src/directions/events.ts:92
  • @@ -65,7 +65,7 @@
    +
  • Defined in src/directions/events.ts:87
  • @@ -75,7 +75,7 @@
    +
  • Defined in src/directions/events.ts:82
  • @@ -83,7 +83,7 @@
    +
  • Defined in src/directions/events.ts:75
  • @@ -92,7 +92,7 @@
    +
  • Defined in src/directions/events.ts:65
  • @@ -100,7 +100,7 @@
    +
  • Defined in src/directions/events.ts:59
  • @@ -20,7 +20,7 @@

    Hierarchy

    • MapLibreGlDirectionsWaypointEventData
    +
  • Defined in src/directions/events.ts:101
  • @@ -42,7 +42,7 @@
    +
  • Defined in src/directions/events.ts:108
  • initialCoordinates: [number, number]
    @@ -51,7 +51,7 @@
    +
  • Defined in src/directions/events.ts:115
  • @@ -89,7 +89,7 @@

    coordinates
  • type
  • @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [P: string]: unknown
    +
  • Defined in src/directions/types.ts:335
  • @@ -40,12 +40,12 @@

    Properties

    geometry: Geometry
    +
  • Defined in src/directions/types.ts:337
  • legs: Leg[]
    +
  • Defined in src/directions/types.ts:338
  • @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [P: string]: unknown
    +
  • Defined in src/directions/types.ts:349
  • @@ -39,7 +39,7 @@

    Properties

    location: [number, number]
    +
  • Defined in src/directions/types.ts:351
  • -

    @maplibre/maplibre-gl-directions - v0.4.2

    +

    @maplibre/maplibre-gl-directions - v0.4.3

    Index

    @@ -70,7 +70,7 @@

    Member Visibility

    Theme

    @@ -16,7 +16,7 @@
  • utils
  • Namespace utilsProtected

    +
  • Defined in src/directions/utils.ts:1
  • Index

    @@ -44,7 +44,7 @@

    Member Visibility

    Theme

    @@ -34,7 +34,7 @@

    Member Visibility

    Theme

    @@ -17,7 +17,7 @@

    Type alias MapLibreGlDirectionsRoutingEventData

    MapLibreGlDirectionsRoutingEventData: Directions
    +
  • Defined in src/directions/events.ts:140
  • @@ -17,7 +17,7 @@

    Type alias PointType

    PointType: "WAYPOINT" | "SNAPPOINT" | "HOVERPOINT" | string
    +
  • Defined in src/directions/types.ts:318