Vertex Viewer SDK
    Preparing search index...

    Interface VertexViewerViewCube

    interface VertexViewerViewCube {
        animationDuration?: number;
        camera?: ReceivedPerspectiveCamera;
        standardViewsOff?: boolean;
        triadOff?: boolean;
        viewAll?: boolean;
        viewer?: HTMLVertexViewerElement;
        worldOrientation?: Orientation;
        xNegativeLabel?: string;
        xPositiveLabel?: string;
        yNegativeLabel?: string;
        yPositiveLabel?: string;
        zNegativeLabel?: string;
        zPositiveLabel?: string;
    }
    Index
    animationDuration?: number

    The duration of the animation, in milliseconds, when a user performs a standard view interaction. Set to 0 to disable animations.

    500
    
    standardViewsOff?: boolean

    Disables interactions for standard views.

    false
    
    triadOff?: boolean

    Disables the display of the triad.

    false
    
    viewAll?: boolean

    Whether to perform a viewAll when clicking on the view cube. If this is set to false, the current lookAt point will be maintained, and the camera's position and up vectors will be aligned to the standard view. Defaults to true.

    Note Setting this value to false can result in the camera being placed underneath geometry depending on the current viewVector length, resulting in a view that may be unexpected.

    true
    
    viewer?: HTMLVertexViewerElement

    The viewer element that is connected to the view cube.

    worldOrientation?: Orientation
    Orientation.DEFAULT
    
    xNegativeLabel?: string

    The label for the side of the cube on the negative x-axis.

    'Left'
    
    xPositiveLabel?: string

    The label for the side of the cube on the positive x-axis.

    'Right'
    
    yNegativeLabel?: string

    The label for the side of the cube on the negative y-axis.

    'Bottom'
    
    yPositiveLabel?: string

    The label for the side of the cube on the positive y-axis.

    'Top'
    
    zNegativeLabel?: string

    The label for the side of the cube on the negative z-axis.

    'Back'
    
    zPositiveLabel?: string

    The label for the side of the cube on the positive z-axis.

    'Front'