MAIDR JavaScript API
    Preparing search index...

    Interface RugPoint

    One observation of a rug, given by its position along the marked axis.

    A vertical rug (Orientation.VERTICAL, the default) draws its ticks standing on the x axis, so the position is x; a horizontal one draws them lying along the y axis, so the position is y. The trace reads the field the orientation names and ignores the other, which lets a producer that already emits a rug as a scatter with a constant on the other axis switch by changing type alone.

    // three observations on the x axis
    { type: 'rug', data: [{ x: 1.5 }, { x: 2.5 }, { x: 7 }] }
    interface RugPoint {
        x?: number;
        y?: number;
    }
    Index

    Properties

    Properties

    x?: number

    The observation's position, for a vertical rug.

    y?: number

    The observation's position, for a horizontal rug.