Interface AxisGridOptions

Constructor options for the AxisGrid entity.

interface AxisGridOptions {
    adaptiveLabels?: boolean;
    name?: string;
    object3d?: Object3D<Object3DEventMap>;
    origin?: AxisGridOrigin;
    style?: Partial<AxisGridStyle>;
    ticks?: AxisGridTicks;
    volume: AxisGridVolume;
}

Hierarchy (view full)

Properties

adaptiveLabels? name? object3d? origin? style? ticks? volume

Properties

OptionaladaptiveLabels

adaptiveLabels?: boolean

Toggles adaptive labels: labels outside the screen will be rendered at the screen edge.

Default Value

false

Optionalname

name?: string

The optional display name of this entity. Mostly used for debugging.

Optionalobject3d

object3d?: Object3D<Object3DEventMap>

The root object of this entity. If none is provided, a new Group is created.

Optionalorigin

origin?: AxisGridOrigin

The origin of the ticks volume

Default Value

TickOrigin.Relative

Optionalstyle

style?: Partial<AxisGridStyle>

The style to apply to lines and labels.

Optionalticks

ticks?: AxisGridTicks

The distance between grid lines.

Default Value

100 on each axis.

volume

volume: AxisGridVolume

The grid volume

Settings

Member Visibility

On This Page

Properties