class Axlsx::WorksheetHyperlink

A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.


the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method

Creates a new hyperlink object.


  • worksheet (Worksheet)

    the Worksheet that owns this hyperlink

  • options (Hash) (defaults to: {})

    options to use when creating this hyperlink

  • [String] (Hash)

    a customizable set of options

  • [Symbol] (Hash)

    a customizable set of options

  • [String|Cell] (Hash)

    a customizable set of options


  • (_self)

Yield Parameters:

  • _self (Axlsx::WorksheetHyperlink)

    the object that the method was called on

The values to be used in serialization based on the target. location should only be specified for non-external targets. r:id should only be specified for external targets.

Cell location of hyperlink on worksheet.

The relationship instance for this hyperlink. A relationship is only required if [email protected]` is `:external`. If not, this method will simply return `nil`.

Sets the target for this hyperlink. Anything other than :external instructs the library to treat the location as an in-workbook reference.


  • target (Symbol)

Seralize the object


  • str (String) (defaults to: '')

WorksheetHyperlink is referenced in 0 repositories