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

    Interface CreatePathLayerOpts<T>

    Options for createPathLayer.

    interface CreatePathLayerOpts<T> {
        colorOverrides?: ColorOverrideRegistry;
        getFill?: (node: T) => FillStyle | null | undefined;
        getNodes: () => readonly T[];
        getPath: (node: T) => Path;
        getStroke?: (node: T) => Stroke | null | undefined;
        getStrokeVertexColors?: (node: T) => number[] | null | undefined;
        getStrokeVertexWidths?: (node: T) => number[] | null | undefined;
        getVertexColors?: (node: T) => number[] | null | undefined;
        id?: string;
        isHidden?: (node: T) => boolean;
        label?: string;
        now?: () => number;
    }

    Type Parameters

    • T
    Index

    Properties

    colorOverrides? getFill? getNodes getPath getStroke? getStrokeVertexColors? getStrokeVertexWidths? getVertexColors? id? isHidden? label? now?

    Properties

    colorOverrides?: ColorOverrideRegistry

    Optional color override registry, typically animator.colorOverrides. When set, the renderer consults it before falling back to getVertexColors / getStrokeVertexColors. Function-form overrides receive the base color array and the current animation timestamp.

    getFill?: (node: T) => FillStyle | null | undefined

    Per-node fill paint. Return null/undefined to skip filling.

    getNodes: () => readonly T[]
    getPath: (node: T) => Path
    getStroke?: (node: T) => Stroke | null | undefined

    Per-node stroke. Return null/undefined to skip stroking.

    getStrokeVertexColors?: (node: T) => number[] | null | undefined

    Per-node stroke vertex-color array, flat RGBA-per-path-anchor, in 0..1 floats (same color space as Stroke.vertexColors). Length must be 4 × countPathAnchors(getPath(node)). When set and getStroke returns null/undefined, a white 1px placeholder stroke is synthesized.

    getStrokeVertexWidths?: (node: T) => number[] | null | undefined

    Per-node stroke vertex-width array (one width per anchor). Length must be countPathAnchors(getPath(node)). The tessellator interpolates half-widths along each segment for tapered strokes. When set and getStroke returns null/undefined, a 1px placeholder stroke is synthesized so the per-anchor widths take effect.

    getVertexColors?: (node: T) => number[] | null | undefined

    Per-node fill vertex-color array, flat RGBA-per-path-anchor, in 0..1 floats (same color space as PathDrawCommand.vertexColors). Length must be 4 × countPathAnchors(getPath(node)). When set and getFill returns null/undefined, a white placeholder fill is synthesized so the renderer's per-vertex shader path activates.

    id?: string
    isHidden?: (node: T) => boolean

    Optional per-node hide hook (e.g., suppress while editing).

    label?: string
    now?: () => number

    Clock used to timestamp function-form color overrides. Defaults to performance.now. Override in tests.

    Settings

    Member Visibility

    On This Page

    Properties