Sha256: eca7bd1d723a3de138846195dfa3c6e10d2339c0f529fcccd49a8cec32dd9c3e

Contents?: true

Size: 1.08 KB

Versions: 4

Compression:

Stored size: 1.08 KB

Contents

# frozen_string_literal: true

module Axlsx
  # A collection of hyperlink objects for a worksheet
  class WorksheetHyperlinks < SimpleTypedList
    # Creates a new Hyperlinks collection
    # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
    def initialize(worksheet)
      DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
      @worksheet = worksheet
      super(WorksheetHyperlink)
    end

    # Creates and adds a new hyperlink based on the options provided
    # @see WorksheetHyperlink#initialize
    # @return [WorksheetHyperlink]
    def add(options)
      self << WorksheetHyperlink.new(@worksheet, options)
      last
    end

    # The relationships required by this collection's hyperlinks
    # @return Array
    def relationships
      return [] if empty?

      map(&:relationship)
    end

    # seralize the collection of hyperlinks
    # @return [String]
    def to_xml_string(str = +'')
      return if empty?

      str << '<hyperlinks>'
      each { |hyperlink| hyperlink.to_xml_string(str) }
      str << '</hyperlinks>'
    end
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
caxlsx-4.1.0 lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb