TomTom Maps for JavaScript
    Preparing search index...

    Type Alias WaypointsConfig

    Configuration for controlling waypoint data sources and display behavior.

    Determines how waypoint position data is processed when rendering waypoints on the map, particularly in relation to entry point information.

    type WaypointsConfig = {
        entryPoints?: GetPositionEntryPointOption;
        icon?: { style?: SVGIconStyleOptions };
    }
    Index

    Properties

    entryPoints? icon?

    Properties

    entryPoints?: GetPositionEntryPointOption

    Controls how entry points are used when displaying waypoints on the map.

    Entry points represent the actual navigable entrance to a location, which may differ from the geometric center coordinates.

    Available options:

    • main-when-available - Uses the main entry point coordinates when available, falling back to the waypoint coordinates
    • ignore - Always uses the original waypoint coordinates

    "ignore"

    icon?: { style?: SVGIconStyleOptions }

    Icon display configuration for waypoints.

    Type Declaration

    • Optionalstyle?: SVGIconStyleOptions

      Base style options for the SVG waypoint icon.

      Use this to set the fill color, outline color, and outline opacity for the default waypoint icon.

      Example:

      baseStyle: {
        fillColor: '#007AFF',
        outlineColor: '#FFFFFF',
        outlineOpacity: 0.8
      }

    Allows customization of the visual style for waypoint icons (origin, destination, stops) on the map.

    Settings

    Member Visibility

    On This Page

    Properties