Method: Axlsx::Styles#parse_border_options

Defined in:
lib/axlsx/stylesheet/styles.rb

#parse_border_options(options = {}) ⇒ Border|Integer

Note:

noop if :border is not specified in options

parses Style#add_style options for borders. Border style definition hashes must include :style and :color key-value entries and may include an :edges entry that references an array of symbols identifying which border edges you wish to apply the style or any other valid Border initializer options. If the :edges entity is not provided the style is applied to all edges of cells that reference this style. Also available :border_top, :border_right, :border_bottom and :border_left options with :style and/or :color key-value entries, which override :border values.

Examples:

#apply a thick red border to the top and bottom
{ :border => { :style => :thick, :color => "FFFF0000", :edges => [:top, :bottom] }

Parameters:

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

    a customizable set of options

Options Hash (options):

  • A (Hash|Integer) —

    border style definition hash or the index of an existing border.

Returns:



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/axlsx/stylesheet/styles.rb', line 366

def parse_border_options(options = {})
  if options[:border].nil? && Border::EDGES.all? { |x| options["border_#{x}".to_sym].nil? }
    return nil
  end

  if options[:border].is_a?(Integer)
    if options[:border] >= borders.size
      raise ArgumentError, (ERR_INVALID_BORDER_ID % options[:border])
    end

    if options[:type] == :dxf
      return borders[options[:border]].clone
    else
      return options[:border]
    end
  end

  validate_border_hash = ->(val) {
    if !(val.keys.include?(:style) && val.keys.include?(:color))
      raise ArgumentError, (ERR_INVALID_BORDER_OPTIONS % options[:border])
    end
  }

  borders_array = []

  if options[:border].nil?
    base_border_opts = {}
  else
    if options[:border].is_a?(Array)
      borders_array += options[:border]

      base_border_opts = {}

      options[:border].each do |b_opts|
        if b_opts[:edges].nil?
          base_border_opts = base_border_opts.merge(b_opts)
        end
      end
    else
      borders_array << options[:border]

      base_border_opts = options[:border]

      validate_border_hash.call(base_border_opts)
    end
  end

  Border::EDGES.each do |edge|
    val = options["border_#{edge}".to_sym]

    if val
      borders_array << val.merge(edges: [edge])
    end
  end

  border = Border.new(base_border_opts)

  Border::EDGES.each do |edge|
    edge_b_opts = base_border_opts

    skip_edge = true

    borders_array.each do |b_opts|
      if b_opts[:edges] && b_opts[:edges].include?(edge)
        edge_b_opts = edge_b_opts.merge(b_opts)
        skip_edge = false
      end
    end

    if options["border_#{edge}".to_sym]
      edge_b_opts = edge_b_opts.merge(options["border_#{edge}".to_sym])
      skip_edge = false
    end

    if skip_edge && base_border_opts[:edges]
      next
    end

    if !edge_b_opts.empty?
      if base_border_opts.empty?
        validate_border_hash.call(edge_b_opts)
      end

      border.prs << BorderPr.new({
        :name => edge,
        :style => edge_b_opts[:style],
        :color => Color.new(:rgb => edge_b_opts[:color])
      })
    end
  end

  if options[:type] == :dxf
    return border
  else
    return borders << border
  end
end