Interface ChartObjectDrawingSource

interface ChartObjectDrawingSource {
    createGroup(
        name: string,
        ids: readonly string[],
    ): null | ChartObjectDrawingGroup;
    drawings(): readonly ChartObjectDrawing[];
    get(id: string): undefined | ChartObjectDrawing;
    groups(): readonly ChartObjectDrawingGroup[];
    hiddenOnInterval(): readonly string[];
    placeInStack(
        id: string,
        target: { drawing: string } | { entry: string },
        where: "above" | "below",
    ): boolean;
    remove(id: string): boolean;
    removeGroup(id: string, removeDrawings?: boolean): boolean;
    removeMany(ids: readonly string[]): void;
    renameGroup(id: string, name: string): boolean;
    reorder(id: string, direction: -1 | 1): boolean;
    select(id: null | string | readonly string[], additive?: boolean): void;
    selection(): readonly string[];
    update(id: string, patch: { locked?: boolean; visible?: boolean }): void;
    updateMany(
        patches: readonly {
            id: string;
            patch: { locked?: boolean; visible?: boolean };
        }[],
    ): void;
}

Methods

  • The ids of the drawings the chart's interval leaves off the chart. Each one's row is marked hiddenOnInterval and offers no focus, which would bring into view a place where nothing is drawn. Asked once per refresh, as a list, so a large inventory costs one pass rather than a lookup per row. Without it every drawing is shown.

    Returns readonly string[]

  • Move a drawing directly above or below another drawing or a series-band entry of its pane, as one undo step. Without it drawings cannot be placed.

    Parameters

    • id: string
    • target: { drawing: string } | { entry: string }
    • where: "above" | "below"

    Returns boolean

  • Parameters

    • id: string
    • OptionalremoveDrawings: boolean

    Returns boolean

  • Delete several as one undo step; a group row holding an unlisted drawing needs it to offer remove.

    Parameters

    • ids: readonly string[]

    Returns void

  • Parameters

    • id: null | string | readonly string[]
    • Optionaladditive: boolean

    Returns void

  • Parameters

    • id: string
    • patch: { locked?: boolean; visible?: boolean }

    Returns void

  • Parameters

    • patches: readonly { id: string; patch: { locked?: boolean; visible?: boolean } }[]

    Returns void