Type Alias TAddMarkerOptions

TAddMarkerOptions: {
    dynamicResize?: boolean;
    enabled?: boolean;
    interactive?: boolean | "pointer-events-auto";
    lowPriorityPin?: { color?: string; enabled?: boolean; size?: number };
    occlude?: boolean;
    placement?: TMarkerPlacement | TMarkerPlacement[];
    rank?: TCollisionRankingTier | "initial";
    zIndex?: number;
}

Options for controlling the behavior of a Marker.

Type declaration

  • OptionaldynamicResize?: boolean

    When true, the marker's collision boundary automatically adjusts when the marker's content or size changes. Set to false for markers with static content that won't change after creation to improve performance.

    Default

    true
  • Optionalenabled?: boolean

    Whether the marker is enabled.

    Default

    true
  • Optionalinteractive?: boolean | "pointer-events-auto"

    Whether the Marker should be clickable. If true the marker will be registered in the SDK interaction events. If 'pointer-events-auto' the marker will receive browser pointer events.

    Default

    false
  • OptionallowPriorityPin?: { color?: string; enabled?: boolean; size?: number }

    Configuration for the low priority pin fallback strategy. When enabled, shows a smaller pin version of the marker when all anchor positions have collisions.

    Default

    { enabled: true, size: 2, color: '#666' }
    • Optionalcolor?: string

      Color of the low priority pin.

      Default

      '#666'
    • Optionalenabled?: boolean

      Whether to enable low priority pin strategy when all anchor positions have collisions.

      Default

      true

      Deprecated

      add 'hidden' to the placement array instead

    • Optionalsize?: number

      Size of the low priority pin in pixels.

      Default

      2
  • Optionalocclude?: boolean

    Whether the marker should be occluded by 3D geometry.

    Default

    true
  • Optionalplacement?: TMarkerPlacement | TMarkerPlacement[]

    Optional. Specifies the placement of the marker, determining its position relative to its coordinates. If a list is provided, the marker will be aligned to the first placement that is available.

    The active placement will be exposed as a DOM attribute data-placement on the marker element.

    For the possible values and their descriptions, see TMarkerPlacement.

  • Optionalrank?: TCollisionRankingTier | "initial"

    Optional. Determines the collision ranking tier of the marker, which influences its visibility in relation to other colliders. For the possible values ('medium', 'high', 'always-visible') and their impact on label visibility, see TCollisionRankingTier.

  • OptionalzIndex?: number

    The z-index of the marker. Can be used used in conjunction with rank: 'always-visible' override the default distance from the camera based sorting of markers and show certain markers always in front

Settings

Member Visibility