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

    Interface GuidesLayerOpts

    Options for createGuidesLayer.

    interface GuidesLayerOpts {
        color?: string;
        dash?: number[];
        getGuides: () => readonly Guide[];
        id?: string;
        label?: string;
        lineWidth?: number;
    }
    Index

    Properties

    color? dash? getGuides id? label? lineWidth?

    Properties

    color?: string

    Stroke color. Default a subtle blue.

    dash?: number[]

    Optional dash pattern (CSS px). Currently unused — reserved for future parity with chrome that supports dashes.

    getGuides: () => readonly Guide[]

    Stable getter for the live guide list — typically useGuides().getGuides.

    id?: string

    Override the layer id. Useful if a consumer needs more than one guides-layer (e.g. user-guides vs. system-guides).

    label?: string

    Override the layer label.

    lineWidth?: number

    Stroke width in CSS pixels. Default 1.

    Settings

    Member Visibility

    On This Page

    Properties