From 282eec44ef01746ee25931fa6cd287ad083fd40b Mon Sep 17 00:00:00 2001 From: Zsolt Kozaroczy Date: Fri, 11 Sep 2020 00:36:29 +0200 Subject: Restructure examples folder (#47) Split examples into separate markdown files, each containing a description, sample code, and a screenshot of the resulting xlsx document. The script `generate.rb` is provided to actually generate the example documents by executing the sample code contained in the markdown files. --- examples/hyperlink_example.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 examples/hyperlink_example.md (limited to 'examples/hyperlink_example.md') diff --git a/examples/hyperlink_example.md b/examples/hyperlink_example.md new file mode 100644 index 00000000..f6d21ca9 --- /dev/null +++ b/examples/hyperlink_example.md @@ -0,0 +1,31 @@ +## Description + +You could create an internal or external hyperlink. The ref could be a string referencing to an existing cell or a cell object. + +## Code + +```ruby +require 'axlsx' + +p = Axlsx::Package.new +wb = p.workbook + +wb.add_worksheet(name: 'Hyperlinks') do |sheet| + # external references + sheet.add_row ['axlsx'] + sheet.add_hyperlink location: 'https://github.com/caxlsx/caxlsx', ref: 'A1' + # internal references + sheet.add_hyperlink location: "'Next Sheet'!A1", ref: 'A2', target: :sheet + sheet.add_row ['next sheet'] +end + +wb.add_worksheet(name: 'Next Sheet') do |sheet| + sheet.add_row ['hello!'] +end + +p.serialize 'hyperlink_example.xlsx' +``` + +## Output + +![Output](images/hyperlink_example.png "Output") -- cgit v1.2.3