Type Alias DrawingPatch

DrawingPatch: Partial<
    Pick<
        Drawing,
        | "points"
        | "style"
        | "text"
        | "props"
        | "locked"
        | "visible"
        | "zIndex"
        | "policy"
        | "space"
        | "viewportPoints",
    >,
> & { intervals?: DrawingIntervalRange
| null; stackAbove?: string | null }

The fields DrawingController.update and updateMany can change. policy merges flag by flag, the way style does.

space on its own converts the anchors at the view on screen, so the drawing stays exactly where it is and only stops (or starts) following the bars. With the new space's anchors in the same patch (viewportPoints for the viewport, points for data) they are taken as given. A conversion the controller cannot make (a tool without viewport support, a pane with no place on screen) is left out of the patch and the rest of it applies, and DrawingController.update returns false.

Type declaration

  • Optionalintervals?: DrawingIntervalRange | null

    The intervals to show the drawing on, replacing any range it had, or null (or a range with neither end) to show it on every interval.

  • OptionalstackAbove?: string | null

    A series-band entry to paint directly above, or null to leave the series band.

Settings

Member Visibility