Skip to content

GridLayer.setAxisMetadata

Summary

GridLayer.setAxisMetadata sets a grid axis name, unit, and optional label side. An omitted label side preserves the current side for that axis.

Syntax

GridLayer.setAxisMetadata(axis: GridAxis, metadata: GridAxisMetadata): this
layer.setAxisMetadata(axis, metadata);

Parameters

Name Type Required Description
axis GridAxis Yes Axis to update.
metadata GridAxisMetadata Yes Name, unit, and optional label side.

Returns

this - The same instance for method chaining.

Type Details

type GridAxis = "u" | "v";
type GridAxisMetadata = {
    name?: string;
    unit?: string;
    labelSide?: GridLabelSide;
};

Example

const grid = wgpu.createOverlay.grid();
grid.setAxisMetadata("u", { name: "Distance", unit: "m", labelSide: "both" });

See Also