Type Alias TPathSectionHighlightOptions

TPathSectionHighlightOptions: {
    animationDuration?: number;
    color?: string;
    displayArrowsOnPath?: boolean;
    widthMultiplier?: number;
}

Configuration options for highlighting a specific section of a path on the map. These options allow you to visually emphasize a segment of a path using custom color, width, and animation duration for user interaction or navigation purposes.

Type declaration

  • OptionalanimationDuration?: number

    Duration of the highlight animation in milliseconds.

    Default

    1500
  • Optionalcolor?: string

    The highlight color for the path section (CSS color string).

    Default

    'red'
  • OptionaldisplayArrowsOnPath?: boolean

    Independently controls whether direction arrows are drawn inside the highlighted section, regardless of the path-level displayArrowsOnPath. If omitted, the highlighted section inherits the path-level setting.

    Animation still follows the path-level animateArrowsOnPath, so the highlighted arrows will animate when the path was created with animateArrowsOnPath: true.

  • OptionalwidthMultiplier?: number

    Multiplies the base path width by this factor for the duration of the highlight.

    Default

    1

Settings

Member Visibility