Interface ReferenceImageJSON

interface ReferenceImageJSON {
    desc?: string;
    hidden?: boolean;
    hyperlink?: Partial<{
        address: string;
        history?: string | Partial<boolean>;
        tgtFrame?: string;
        tooltip?: string;
    }>;
    id?: boolean;
    lockAspect?: boolean;
    locks?: any;
    name?: string;
    presetGeom?: string;
    resId?: number;
    rotation?: number;
}

Hierarchy (view full)

Properties

desc? hidden? hyperlink? id? lockAspect? locks? name? presetGeom? resId? rotation?

Properties

Optional desc

desc?: string

This is the alternative text use for assistive technologies.

Default Value

null

Optional hidden

hidden?: boolean

If true then the drawing object is hidden.

Default Value

false

Optional hyperlink

hyperlink?: Partial<{
    address: string;
    history?: string | Partial<boolean>;
    tgtFrame?: string;
    tooltip?: string;
}>

A hyperlink for the entire drawing area

Type declaration

  • address: string

    This can be a url or a cell address. Note - sheet address need to start with a #

  • Optional history?: string | Partial<boolean>

    Specifies whether to add this URI to the history when navigating to it.

    Default Value

    true
  • Optional tgtFrame?: string

    Specified the target frame when opening this Hyperlink.

    Default Value

    newWindow
  • Optional tooltip?: string

    A text that can show addition information about the link that will be displayed as a tooltip.

    Remark

    Excel has an undocumented tooltip length limit of 255 characters.

Optional id

id?: boolean

A unique identifier for the drawing object. This is not used by SheetXL

Optional lockAspect

lockAspect?: boolean

Whether resizing should keep the aspect ratio.

Optional locks

locks?: any

lock specific fields

Optional name

name?: string

The name of the drawing object.

Optional presetGeom

presetGeom?: string

The preset Geometry for the shape. This could also be custom.

Default Value

'rect'

Optional resId

resId?: number

The resource id for the image. The actual image data is stored in the resource.

Optional rotation

rotation?: number

The rotation in degrees.

Default Value

0

Settings

Member Visibility

Theme

On This Page

deschiddenhyperlinkidlockAspectlocksnamepresetGeomresIdrotation