@jpmorganchase/anu / Exports / AxesConfig

Class: AxesConfig

Configuration class for setting up axes in a 3D scene.

Table of contents

Constructors

• constructor

Properties

• atlas
• background
• backgroundOptions
• backgroundPosition
• backgroundProperties
• domain
• domainMaterialOptions
• domainOptions
• domainProperties
• grid
• gridOptions
• gridProperties
• gridTicks
• label
• labelFormat
• labelMargin
• labelOptions
• labelProperties
• labelTicks
• parent
• scale

Constructors

constructor

• new AxesConfig(scales): AxesConfig

Constructs an AxesConfig instance with the given scales.

Parameters

Name	Type	Description
scales	AxesScales	The scales for the axes.

Returns

AxesConfig

Defined in

src/prefabs/Axis/AxisOptions.ts:178

Properties

atlas

• Optional atlas: Texture

Texture atlas for the labels.

Defined in

src/prefabs/Axis/AxisOptions.ts:172

---

background

• Optional background: boolean | { x?: boolean ; y?: boolean ; z?: boolean }

Render the background or not. Can be a boolean or an object specifying each axis.

Default

{x: true, y: true, z: true}

Defined in

src/prefabs/Axis/AxisOptions.ts:89

---

backgroundOptions

• Optional backgroundOptions: {} | { backUVs?: Vector4 ; frontUVs?: Vector4 ; height?: number ; sideOrientation?: number ; size?: number ; sourcePlane?: Plane ; updatable?: boolean ; width?: number } | { x?: { backUVs?: Vector4 ; frontUVs?: Vector4 ; height?: number ; sideOrientation?: number ; size?: number ; sourcePlane?: Plane ; updatable?: boolean ; width?: number } ; y?: { backUVs?: Vector4 ; frontUVs?: Vector4 ; height?: number ; sideOrientation?: number ; size?: number ; sourcePlane?: Plane ; updatable?: boolean ; width?: number } ; z?: { backUVs?: Vector4 ; frontUVs?: Vector4 ; height?: number ; sideOrientation?: number ; size?: number ; sourcePlane?: Plane ; updatable?: boolean ; width?: number } }

Initial options for the background planes.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:95

---

backgroundPosition

• Optional backgroundPosition: Object

Position of the background planes.

Default

{x: 0, y: 0, z: 0}

Type declaration

Name	Type
x?	0 | 1
y?	0 | 1
z?	0 | 1

Defined in

src/prefabs/Axis/AxisOptions.ts:107

---

backgroundProperties

• Optional backgroundProperties: {} | Partial<Pick<Mesh, PropertyKeys<Mesh>>> | { x?: Partial<Pick<Mesh, PropertyKeys<Mesh>>> ; y?: Partial<Pick<Mesh, PropertyKeys<Mesh>>> ; z?: Partial<Pick<Mesh, PropertyKeys<Mesh>>> }

Properties of the background planes.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:101

---

domain

• Optional domain: boolean | { x?: boolean ; y?: boolean ; z?: boolean }

Render the domain or not. Can be a boolean or an object specifying each axis.

Default

{x: true, y: true, z: true}

Defined in

src/prefabs/Axis/AxisOptions.ts:65

---

domainMaterialOptions

• Optional domainMaterialOptions: GreasedLineMaterialBuilderOptions = {}

Initial options of the GreasedLine material.

Default

{}

Defined in

src/prefabs/Axis/AxisOptions.ts:77

---

domainOptions

• Optional domainOptions: {} | GreasedLineMeshBuilderOptions = {}

Initial options of the GreasedLine mesh.

Default

{}

Defined in

src/prefabs/Axis/AxisOptions.ts:71

---

domainProperties

• Optional domainProperties: Partial<Pick<GreasedLineMesh, PropertyKeys<GreasedLineMesh>>> = {}

Properties of the GreasedLine mesh.

Default

{}

Defined in

src/prefabs/Axis/AxisOptions.ts:83

---

grid

• Optional grid: boolean | { x?: boolean ; y?: boolean ; z?: boolean }

Render the grid lines or not. Can be a boolean or an object specifying each axis.

Default

{x: true, y: true, z: true}

Defined in

src/prefabs/Axis/AxisOptions.ts:113

---

gridOptions

• Optional gridOptions: {} | { colors?: Color4[][] ; instance?: LinesMesh ; lines: Vector3[][] ; material?: Material ; updatable?: boolean ; useVertexAlpha?: boolean } | { x?: { colors?: Color4[][] ; instance?: LinesMesh ; lines: Vector3[][] ; material?: Material ; updatable?: boolean ; useVertexAlpha?: boolean } ; y?: { colors?: Color4[][] ; instance?: LinesMesh ; lines: Vector3[][] ; material?: Material ; updatable?: boolean ; useVertexAlpha?: boolean } ; z?: { colors?: Color4[][] ; instance?: LinesMesh ; lines: Vector3[][] ; material?: Material ; updatable?: boolean ; useVertexAlpha?: boolean } }

Initial options of the LineSystem mesh.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:119

---

gridProperties

• Optional gridProperties: {} | Partial<Pick<LinesMesh, PropertyKeys<LinesMesh>>> | { x?: Partial<Pick<LinesMesh, PropertyKeys<LinesMesh>>> ; y?: Partial<Pick<LinesMesh, PropertyKeys<LinesMesh>>> ; z?: Partial<Pick<LinesMesh, PropertyKeys<LinesMesh>>> }

Properties of the LineSystem mesh.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:125

---

gridTicks

• Optional gridTicks: Object

Array of values for ticks to be drawn.

Default

{x: undefined, y: undefined, z: undefined}

Type declaration

Name	Type
x?	(string | number)[]
y?	(string | number)[]
z?	(string | number)[]

Defined in

src/prefabs/Axis/AxisOptions.ts:131

---

label

• Optional label: boolean | { x?: boolean ; y?: boolean ; z?: boolean }

Render the labels or not. Can be a boolean or an object specifying each axis.

Default

{x: true, y: true, z: true}

Defined in

src/prefabs/Axis/AxisOptions.ts:137

---

labelFormat

• Optional labelFormat: Object

A function that formats the label text.

Default

{x: undefined, y: undefined, z: undefined}

Type declaration

Name	Type
x?	(d: string) => string
y?	(d: string) => string
z?	(d: string) => string

Defined in

src/prefabs/Axis/AxisOptions.ts:161

---

labelMargin

• Optional labelMargin: Object

Margin for the labels.

Default

{x: 0.15, y: 0.15, z: 0.15}

Type declaration

Name	Type
x?	number
y?	number
z?	number

Defined in

src/prefabs/Axis/AxisOptions.ts:167

---

labelOptions

• Optional labelOptions: {} | PlaneTextOptions | { x?: PlaneTextOptions ; y?: PlaneTextOptions ; z?: PlaneTextOptions }

Initial options of the PlaneText mesh.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:143

---

labelProperties

• Optional labelProperties: {} | Partial<Pick<PlaneText, PropertyKeys<Mesh>>> | { x?: Partial<Pick<PlaneText, PropertyKeys<Mesh>>> ; y?: Partial<Pick<PlaneText, PropertyKeys<Mesh>>> ; z?: Partial<Pick<PlaneText, PropertyKeys<Mesh>>> }

Properties of the PlaneText mesh.

Default

{x: {}, y: {}, z: {}}

Defined in

src/prefabs/Axis/AxisOptions.ts:149

---

labelTicks

• Optional labelTicks: Object

Array of values for ticks to be drawn.

Default

{x: undefined, y: undefined, z: undefined}

Type declaration

Name	Type
x?	(string | number)[]
y?	(string | number)[]
z?	(string | number)[]

Defined in

src/prefabs/Axis/AxisOptions.ts:155

---

parent

• Optional parent: Selection | Node

Selection that defines the parent node. If not set, a parent node will be created at the root of the scene graph.

Defined in

src/prefabs/Axis/AxisOptions.ts:59

---

scale

• Optional scale: Object

The scale(s) of the axes you want to render. At least one is required.

Type declaration

Name	Type
x?	any
y?	any
z?	any

Defined in

src/prefabs/Axis/AxisOptions.ts:54