API / geotoolkit3d / scene / grid / Grid / Grid
Type Aliases
Type Aliases
Ƭ FormatterCallback: (value: number, axisSize?: number) => string
▸ (value, axisSize?): string
| Name | Type |
|---|---|
value | number |
Optional axisSize | number |
string
Ƭ Formatters: Object
| Name | Type | Description |
|---|---|---|
x | FormatterCallback | The label text formatter for the X axis |
y | FormatterCallback | The label text formatter for the Y axis |
z | FormatterCallback | The label text formatter for the Z axis |
Ƭ LineStyle: Object
| Name | Type | Description |
|---|---|---|
x? | Type | The X grid line style |
y? | Type | The Y grid line style |
z? | Type | The Z grid line style |
Ƭ ModeCallback: (gridPlane: ThreeObject3D, scene: Scene, camera: PerspectiveCamera | OrthographicCamera) => boolean
▸ (gridPlane, scene, camera): boolean
Callback function to define which plane of the grid should be visible. See Mode methods for the built-in modes.
| Name | Type |
|---|---|
gridPlane | ThreeObject3D |
scene | Scene |
camera | PerspectiveCamera | OrthographicCamera |
boolean
Ƭ Options: Omit<Options, "isselectable"> & { axis?: { distance?: number ; formatters?: { x?: FormatterCallback ; y?: FormatterCallback ; z?: FormatterCallback } ; linestyles?: { x?: Type ; y?: Type ; z?: Type } ; outlines?: OutlinesOptions ; textstyles?: { x?: Type ; y?: Type ; z?: Type } } ; counts?: Vector3 ; end?: Vector3 ; grid?: { linestyles?: { x?: Type ; y?: Type ; z?: Type } } ; levels?: Range ; mode?: Mode | ModeCallback ; modelend?: Vector3 ; modelstart?: Vector3 ; planecolor?: string | Color ; planeopacity?: number ; start?: Vector3 ; tickgenerators?: TickGenerators ; title?: { distance?: number ; outlines?: OutlinesOptions ; texts?: { x?: string ; y?: string ; z?: string } ; textstyles?: { x?: Type ; y?: Type ; z?: Type } } }
The options
Ƭ OptionsBase: Options
The options
Ƭ OptionsBaseOut: Required<OptionsBase & Options>
Ƭ OutlinesOptions: Object
| Name | Type | Description |
|---|---|---|
x? | OutlineOptions | The labels outline options on the X axis |
y? | OutlineOptions | The labels outline options on the Y axis |
z? | OutlineOptions | The labels outline options on the Z axis |
Ƭ PlaneName: "right" | "left" | "bottom" | "top" | "front" | "back"
Ƭ TextStyles: Object
| Name | Type | Description |
|---|---|---|
x? | Type | The text style for the X axis |
y? | Type | The text style for the Y axis |
z? | Type | The text style for the Z axis |
Ƭ TickGenerators: Object
| Name | Type | Description |
|---|---|---|
x? | TickGenerator | The tick generator to use for the X axis |
y? | TickGenerator | The tick generator to use for the Y axis |
z? | TickGenerator | The tick generator to use for the Z axis |