weasel API - v0.8.0
    Preparing search index...

    Interface GridLayerOpts

    Options for createGridLayer.

    interface GridLayerOpts {
        accentEvery?: number;
        bounds: () => { height: number; width: number; x: number; y: number };
        spacing: UnitValue;
        style?: { accent?: Stroke; line?: Stroke; sub?: Stroke };
        subdivisions?: number;
        unitSystem?: UnitSystem;
    }
    Index

    Properties

    accentEvery? bounds spacing style? subdivisions? unitSystem?

    Properties

    accentEvery?: number

    Lines every N cells get the accent style. 0/undef = no accent.

    bounds: () => { height: number; width: number; x: number; y: number }

    Bounds of the area to cover, in world units.

    spacing: UnitValue

    Distance between adjacent grid lines (also known as grid pitch), in world (base) units. Accepts a bare number or a tagged { value, unit }. Tagged values require unitSystem to be supplied.

    style?: { accent?: Stroke; line?: Stroke; sub?: Stroke }

    Per-band stroke styles. Each is a FillStyle+width (etc.) — see Stroke.

    subdivisions?: number

    Optional finer subdivisions per cell. e.g. 4 -> 4 sub-lines per cell.

    unitSystem?: UnitSystem

    Optional unit system for resolving tagged spacing values.

    Settings

    Member Visibility

    On This Page

    Properties