Type Alias TClickPayload

TClickPayload: {
    areas?: Area[];
    coordinate: Coordinate;
    facades?: Facade[];
    floors?: Floor[];
    labels?: Label[];
    markers?: Marker[];
    models?: Model[];
    objects?: MapObject[];
    paths?: Path[];
    pointerEvent: Pick<PointerEvent, "button">;
    shapes?: Shape[];
    spaces?: Space[];
}

The payload for a user click event on the map.

Contains detailed information about all visible interactive map elements that were under the pointer at the time of the event.

Properties are optional and included only when corresponding objects are present at the pointer location.

Type declaration

  • Optionalareas?: Area[]

    Interactive Areas under the pointer.

  • coordinate: Coordinate

    The geographic Coordinate of the pointer event.

  • Optionalfacades?: Facade[]

    Interactive Facades under the pointer.

  • Optionalfloors?: Floor[]

    Interactive Floors under the pointer.

  • Optionallabels?: Label[]

    Interactive Labels under the pointer.

  • Optionalmarkers?: Marker[]

    Interactive Markers under the pointer.

  • Optionalmodels?: Model[]

    Interactive Models under the pointer.

  • Optionalobjects?: MapObject[]

    Interactive Objects under the pointer.

  • Optionalpaths?: Path[]

    Interactive Paths under the pointer.

  • pointerEvent: Pick<PointerEvent, "button">

    Details about the pointer event triggering this click, containing only the pointer button.

  • Optionalshapes?: Shape[]

    Interactive Shapes under the pointer.

  • Optionalspaces?: Space[]

    Interactive Spaces under the pointer.

Settings

Member Visibility