Type Alias TMarkerState

TMarkerState: {
    contentHTML: string;
    dynamicResize: boolean;
    element: HTMLElement;
    enabled: boolean;
    interactive: boolean | "pointer-events-auto";
    lowPriorityPin?: { color?: string; enabled?: boolean; size?: number };
    occlude: boolean;
    placement?:
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right"
        | "hidden"
        | "right"
        | "left"
        | "top"
        | "center"
        | "bottom"
        | (
            | "top-left"
            | "top-right"
            | "bottom-left"
            | "bottom-right"
            | "hidden"
            | "right"
            | "left"
            | "top"
            | "center"
            | "bottom"
        )[];
    rank: TCollisionRankingTier
    | "initial";
    type: "marker";
    zIndex?: number;
}

Type declaration

  • contentHTML: string

    HTML content of the marker as text

  • dynamicResize: boolean

    When true, the marker's collision boundary automatically adjusts when the marker's content or size changes.

    Default

    true
  • element: HTMLElement

    HTML element for the marker.

  • enabled: boolean

    Whether the marker is enabled.

    Default

    true
  • interactive: boolean | "pointer-events-auto"

    Whether the Marker should be clickable.

    Default

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

    Configuration for the low priority pin fallback strategy.

    • Optionalcolor?: string

      Color of the low priority pin.

    • Optionalenabled?: boolean

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

    • Optionalsize?: number

      Size of the low priority pin in pixels.

  • occlude: boolean

    Whether the marker should be occluded by 3D geometry.

    Default

    true
  • Optionalplacement?:
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right"
        | "hidden"
        | "right"
        | "left"
        | "top"
        | "center"
        | "bottom"
        | (
            | "top-left"
            | "top-right"
            | "bottom-left"
            | "bottom-right"
            | "hidden"
            | "right"
            | "left"
            | "top"
            | "center"
            | "bottom"
        )[]

    Specifies the placement of the marker, determining its position relative to its coordinates. Can be a single placement or an array of placements.

  • rank: TCollisionRankingTier | "initial"

    Determines the collision ranking tier of the marker, which influences its visibility in relation to other colliders.

    Default

    'medium'
  • type: "marker"
  • OptionalzIndex?: number

    The z-index of the marker.

Settings

Member Visibility