SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface JSON

    A JSON representation useful for persistence.

    interface JSON {
        adjustments?: Record<string, number>;
        connectorEnds?: { end?: ConnectorEndJSON; start?: ConnectorEndJSON };
        effects?: IEffect.JSON[];
        extLst?: ExtLstJSON;
        fill?:
            | NoneJSON
            | GradientJSON
            | PatternJSON
            | SolidJSON
            | ImageJSON
            | GroupJSON;
        geometry?: string
        | Def;
        hoverHyperlink?: IHyperlink.JSON;
        hyperlink?: IHyperlink.JSON;
        locks?: Record<string, boolean>;
        locksText?: boolean;
        macro?: string;
        name?: string;
        published?: boolean;
        scene3d?: string;
        shape3d?: string;
        sourceId?: number;
        stroke?: IStroke.JSON;
        style?: StyleRefsJSON | null;
        text?: ITextFrame.JSON;
        textBox?: boolean;
        textLink?: string;
        title?: string;
        type?: IShape.Type;
    }

    Hierarchy

    Index
    adjustments?: Record<string, number>

    Adjust values that differ from the preset's defaults, by name (adj, adj1…).

    connectorEnds?: { end?: ConnectorEndJSON; start?: ConnectorEndJSON }

    A connector's glued ends.

    effects?: IEffect.JSON[]

    The shape's effects (spPr/effectLst). An empty list is an explicit none: the element present and empty, which turns off the effects the shape's theme style would give it.

    extLst?: ExtLstJSON

    Extension lists kept as the file states them, by the element each extends.

    The fill. A group fill takes the fill of the group the shape is a member of (the nearest one that states a fill), and the shape's theme style outside a group.

    geometry?: string | Def
    hoverHyperlink?: IHyperlink.JSON

    The hyperlink followed on hover (cNvPr/hlinkHover).

    hyperlink?: IHyperlink.JSON

    The hyperlink on the whole shape (cNvPr/hlinkClick).

    locks?: Record<string, boolean>

    Edit locks (spLocks/cxnSpLocks) by the file's own names: noGrp, noSelect, noRot, noChangeAspect, noMove, noResize, noEditPoints, noAdjustHandles, noChangeArrowheads, noChangeShapeType, noTextEdit.

    locksText?: boolean

    The text cannot be edited while the sheet is protected (sp/@fLocksText).

    macro?: string

    The macro bound to the shape (sp/@macro), as the file states it.

    name?: string

    The name of the shape.

    published?: boolean

    sp/@fPublished.

    scene3d?: string

    The 3-D scene (spPr/scene3d) as the file states it: an opaque DrawingML fragment.

    shape3d?: string

    The 3-D shape properties (spPr/sp3d) as the file states it: an opaque DrawingML fragment.

    sourceId?: number

    The id the file gave the shape (cNvPr/@id), which is what a connector's connectorEnds name their targets by. A file writes the shape with this id again (made unique when two shapes share one, as a copy does); a shape without one takes the next.

    stroke?: IStroke.JSON
    style?: StyleRefsJSON | null

    The theme style the shape draws with wherever it states no fill, stroke or text color of its own: the file's style element, which refers into the theme's format scheme by position. A reference not stated is Excel's for a new shape (a connector's differ: the first line, no fill); null, the shape has no style and draws only what it states itself.

    The text written on the shape, by paragraph. Absent for a shape with no text body.

    textBox?: boolean

    The shape was inserted as a text box (cNvSpPr/@txBox).

    textLink?: string

    The cell a text box's text is linked to (sp/@textlink), as the file states it.

    title?: string

    The title (cNvPr/@title), beside the description.

    type?: IShape.Type

    What kind of drawing this is. Absent for a shape; a connector states its.