CellHyperlink | @sheetwrite/core

Bounded serializable hyperlink metadata applied to one cell or range.

Package: @sheetwrite/core
Source: packages/core/src/types/cell.ts#L56

Members 5

id Stable identity used by operations, history, and collaboration rebase.

id: string;

range

range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;

target

target: HyperlinkTargettype HyperlinkTarget =
  | { kind: "external"; url: string }
  | { kind: "internal"; range: Range };type HyperlinkTarget =
  | { kind: "external"; url: string }
  | { kind: "internal"; range: Range };type HyperlinkTarget =
  | {
      kind: "external";
      url: string;
    }
  | {
      kind: "internal";
      range: Range;
    };Browser-safe external target or stable workbook-internal range target.API reference →;

display Optional accessible/OOXML display label; cell values remain authoritative.

display?: string;

style Optional override merged over the deterministic blue/underline link style.

style?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;

Declaration

View full TypeScript declaration

export interface CellHyperlink {
  id: string;
  range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;
  target: HyperlinkTargettype HyperlinkTarget =
  | { kind: "external"; url: string }
  | { kind: "internal"; range: Range };type HyperlinkTarget =
  | { kind: "external"; url: string }
  | { kind: "internal"; range: Range };type HyperlinkTarget =
  | {
      kind: "external";
      url: string;
    }
  | {
      kind: "internal";
      range: Range;
    };Browser-safe external target or stable workbook-internal range target.API reference →;
  display?: string;
  style?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;
}