TomTom Maps for JavaScript
    Preparing search index...

    Type Alias GuidanceParams

    Configuration for turn-by-turn guidance instructions.

    Specifies the format and detail level for navigation guidance.

    // Request coded guidance with phonetics
    const guidance: GuidanceParams = {
      type: 'coded',
      version: 2,
      phonetics: 'IPA',
      roadShieldReferences: 'all'
    };
    type GuidanceParams = {
        phonetics?: "LHP" | "IPA";
        roadShieldReferences?: "all";
        type: "coded";
        version?: 2;
    }
    Index

    Properties

    phonetics? roadShieldReferences? type version?

    Properties

    phonetics?: "LHP" | "IPA"

    Phonetic transcription format for street names.

    • LHP: Language-specific phonetic representation
    • IPA: International Phonetic Alphabet
    'IPA'
    roadShieldReferences?: "all"

    Include road shield references for displaying road signs.

    When set to 'all', includes references to road shield images that can be fetched from the TomTom Road Shield API.

    type: "coded"

    Guidance instruction format type.

    Currently only 'coded' format is supported.

    version?: 2

    Guidance instruction version.

    2

    Settings

    Member Visibility

    On This Page

    Properties