Type alias TDrawNavigationOptions

TDrawNavigationOptions: {
    connectionPathOptions?: TAddPathOptions;
    connectionTemplate?: (({ direction, type, toMapName }) => string);
    departureMarkerTemplate?: (({ icon, location }) => string);
    destinationMarkerTemplate?: (({ icon, location }) => string);
    inactivePathOptions?: TAddPathOptions;
    pathOptions?: TAddPathOptions;
    polygonHighlightColor?: string | false;
}

Configure the behaviour of a INavigation.

Type declaration

  • Optional connectionPathOptions?: TAddPathOptions

    Path Options for map to map vertical paths.

  • Optional connectionTemplate?: (({ direction, type, toMapName }) => string)
      • ({ direction, type, toMapName }): string
      • Function that returns an HTML template to use as a Connection tooltips (elevators, escalators, etc)

        Parameters

        Returns string

  • Optional departureMarkerTemplate?: (({ icon, location }) => string)
      • ({ icon, location }): string
      • Function that returns an HTML template to use as a departure marker. Override with null | undefined to disable

        Parameters

        • { icon, location }: {
              icon: string;
              location?: any;
          }
          • icon: string
          • Optional location?: any

        Returns string

  • Optional destinationMarkerTemplate?: (({ icon, location }) => string)
      • ({ icon, location }): string
      • Function that returns an HTML template to use as a destination marker. Override with null | undefined to disable

        Parameters

        • { icon, location }: {
              icon: string;
              location?: any;
          }
          • icon: string
          • Optional location?: any

        Returns string

  • Optional inactivePathOptions?: TAddPathOptions

    Path Options for the non-current path in multi-destination mode.

  • Optional pathOptions?: TAddPathOptions

    Path Options

  • Optional polygonHighlightColor?: string | false

    Color to highlight departure and destination spaces. Color can be set using CSS colors names DarkGoldenRod, as Hex strings #0000FF or the rgb values rgb(255,0,0). Pass false to disable.

    Default

    '#7babc8'