AVP 3DWS Deck Documentation
    Preparing search index...

    Interface DeckHtmlAttributes

    These Javascript properties are used by the web component.

    Important Note:

    All JavaScript properties are exposed as HTML attributes with a change in casing. JavaScript properties are defined in camelCase, whereas the corresponding HTML attributes are available in kebab-case.

    For example, the configId property can be used as an HTML attribute via config-id.

    interface DeckHtmlAttributes {
        active?: boolean;
        camera?: string;
        "camera-flight"?: "enabled" | "disabled";
        "config-id": string;
        "consumption-data"?: string;
        "content-lang"?: string;
        design?:
            | "default"
            | "ngc"
            | "vw"
            | "vw-exhibition"
            | "alpha"
            | "alpha-exhibition"
            | "alpha-customizer"
            | "lamborghini-exhibition";
        dev?: boolean;
        features?: string;
        "hide-consumption-data"?: boolean;
        market?: string;
        "multisession-disconnect"?: boolean;
        "pr-string"?: string;
        "session-id"?: string;
        "streaming-stage"?: StreamingStage;
    }
    Index

    Properties

    active? camera? camera-flight? config-id consumption-data? content-lang? design? dev? features? hide-consumption-data? market? multisession-disconnect? pr-string? session-id? streaming-stage?

    Properties

    active?: boolean

    Controls if the stream is playing or not

    camera?: string

    Provide camera id to load a specific camera

    "camera-flight"?: "enabled" | "disabled"

    Controls the camera flight. Set to "enabled" to start the flight or "disabled" to stop it. This takes precedence over what is set in the config for the cameraFlightOnStart property.

    "config-id": string

    The ID of a configuration to fetch to configure the app UI and the stream

    "consumption-data"?: string

    The car's consumption data (WLTP). Will be passed to the AVE to display in-stream.

    WARNING: Changing this attribute in an active stream will NOT trigger any immediate changes since the AVE only updates the consumption data when the PR string changes! To update the consumption data please update the PR string.

    Optionalcontent-lang

    "content-lang"?: string

    Specifies the language of the component for accessibility purposes. The value must be a valid BCP 47 language tag (e.g., "en", "de", "fr", "es-ES"). This attribute helps assistive technologies to determine the correct pronunciation and formatting for the content within the component. If not provided, the component will attempt to detect the language from the host document's <html> lang attribute. Will fall back to English ("en") if language detection fails or if the specified language is not supported.

    design?:
        | "default"
        | "ngc"
        | "vw"
        | "vw-exhibition"
        | "alpha"
        | "alpha-exhibition"
        | "alpha-customizer"
        | "lamborghini-exhibition"

    Overrides the design used by 3D Showroom specified in the 'template' config property. Accepts one of the following values: "ngc", "vw", "vw-exhibition", "lamborghini-exhibition", "default", or "alpha". Defaults to "ngc" for Audi brand and "default" for all other brands.

    dev?: boolean

    For development purposes. In "dev" mode, the stream UI is shown even without the 3D stream running.

    features?: string

    Enable or disable specific features by providing a stringified object of type DeckFeatureFlags. This is a partial runtime override of the configuration via config-id. Only the features specified in this attribute will be overridden.

    features="{\"zoom\":true}"
    "hide-consumption-data"?: boolean

    Disables viewing the car's consumption data (WLTP). Can be disabled in use cases where consumption data will be displayed separately by the integrator.

    market?: string

    The market that the streaming connection should be initiated with. If no market is provided here, instead the market in the cms config will be used.

    "multisession-disconnect"?: boolean

    Enables or disables the termination of a multi-session on disconnect. Supposed be set on the host implementation side in order to terminate a 3D remote multi-session, once the host closes the stream.

    "pr-string"?: string

    The car configuration of the streamed vehicle. Updating this will immediately take effect in the stream.

    "session-id"?: string

    Existing Session ID to connect the stream to

    "streaming-stage"?: StreamingStage

    The streaming stage to use, will default to the stage specified in the config if unset.

    Settings

    Member Visibility

    On This Page

    Properties