P3d.in Embed API
    Preparing search index...

    Interface P3dEmbedApiOptions

    interface P3dEmbedApiOptions {
        hoverRate?: number;
        onclick?: (data: P3dEmbedApiClick) => void;
        onhover?: (data: P3dEmbedApiPick) => void;
        onload?: () => void;
        onready?: () => void;
        onstatus?: (status: "idle" | "interacting") => void;
    }
    Index

    Properties

    hoverRate? onclick? onhover? onload? onready? onstatus?

    Properties

    hoverRate?: number

    Maximum rate in milliseconds that hover events are fired. Default: 100 ms

    onclick?: (data: P3dEmbedApiClick) => void

    Callback that triggers when user clicks inside the embed

    onhover?: (data: P3dEmbedApiPick) => void

    Callback that triggers when user moves (or "hovers") the pointer inside the embed. Fires at maximum 10 times per second

    onload?: () => void

    Callback that triggers whe model is finished loading and is displayed to the user

    onready?: () => void

    Callback that triggers when embed api is ready to start communicating with the embed iframe. This however does not mean that the model has finished loading.

    onstatus?: (status: "idle" | "interacting") => void

    Callback that triggers when viewer interaction status changes. By default status is idle. If user is interacting with the model the callback returns interacting. This can be useful for hiding or disabling overlay elements during model navigation

    Settings

    Member Visibility

    On This Page

    Properties