Type alias TDirectionToOptions

TDirectionToOptions: {
    accessible?: boolean;
    excludedNodeIds?: string[];
    excludedVortexIds?: string[];
    includedVortexIds?: string[];
    merge?: boolean;
    simplify?: TSimplifyDirectionsOptions;
}

Type declaration

  • Optional accessible?: boolean

    If true directions will only take accessible routes

    Default

    false
  • Optional excludedNodeIds?: string[]

    Exclude all the nodes matching the given IDs

  • Optional excludedVortexIds?: string[]

    Exclude all the vortexes matching the given IDs

  • Optional includedVortexIds?: string[]

    Include all the vortexes matching the given IDs

  • Optional merge?: boolean

    When true, merges multi-destination direction segments into a single directions object. The merged result will have a combined path, summed distance, and concatenated instructions. Only applies when using MappedinDestinationSet with multiple destinations.

  • Optional Experimental simplify?: TSimplifyDirectionsOptions

    Apply line-of-sight simplifying to directions. This will attempt to remove unnecessary nodes between turns.

Settings

Member Visibility

Theme