Type Alias MaptilerARControlOptions
activateAR?: boolean;
arButtonClassName?: string;
arButtonContent?: string | HTMLElement;
background?: string;
closeButtonClassName?: string;
closeButtonContent?: string | HTMLElement;
edgeColor?: string;
highRes?: false;
logo?: string;
logoClass?: string;
logoHeight?: number;
showButton?: boolean;
}
Properties
OptionalactivateAR
When the platform allows, setting this to true automatically activates the AR mode as soon as the data is ready.
Quick Look on iOS is likely to allow this, while WebXR on Android is not likeley to.
Default: false
OptionalarButtonClassName
CSS class to add to the AR button on the AR modal. If none is provided, a default inline style is added. Default: none
OptionalarButtonContent
Content to add to the AR button. If the content is a string, it is added as .innerHTML
if it's a DOM element, it is added as .appendChild().
Default: "Close"
Optionalbackground
Background color (css compatible).
Default: "#FFFFFF" (white)
OptionalcloseButtonClassName
CSS class to add to the close button on the AR modal. If none is provided, a default inline style is added. Default: none
OptionalcloseButtonContent
Content to add to the close button. If the content is a string, it is added as .innerHTML
if it's a DOM element, it is added as .appendChild().
Default: "Close"
OptionaledgeColor
Color of the 3D model edges.
Default: "#0eaeff" (grayish teal)
OptionalhighRes
Generate a mesh with a higher resolution texture.
Default: false
Optionallogo
The URL to a logo image to be placed on top of the 3D view (in browser).
The image is located by default on the bottom-left corner but this can be changed with
the option .logoClass.
Default: "" (empty string, no image)
OptionallogoClass
CSS class to add to the logo image specified with the .logo option.
If a CSS class is provided, the option .logoHeight will be ignored and the class is expected to
include instruction about width and/or height.
Default: "" (empty string, no class spacified)
OptionallogoHeight
Height in pixel of the logo.
Default: 60
OptionalshowButton
Shows the AR button if true, hide it otherwise.
Default: true
Options for the Maptiler AR Control