Skip to content

Commit

Permalink
formatting doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jlangch committed Sep 3, 2024
1 parent 17ced18 commit 3661ccc
Showing 1 changed file with 72 additions and 55 deletions.
127 changes: 72 additions & 55 deletions src/main/resources/com/github/jlangch/venice/excel.venice
Original file line number Diff line number Diff line change
Expand Up @@ -819,10 +819,15 @@

(defn
^{ :arglists '(
"(add-conditional-bg-color sheet
rule bg-color-html
region-first-row region-last-row
region-first-col region-last-col)")
"""
(add-conditional-bg-color sheet
rule
bg-color-html
region-first-row
region-last-row
region-first-col
region-last-col)
""")
:doc "Add a conditional background color"
:examples '(
"""
Expand Down Expand Up @@ -862,13 +867,17 @@

(defn
^{ :arglists '(
"(add-text-data-validation sheet
strings
empty-cell-allowed
err-title
err-text
region-first-row region-last-row,
region-first-col, region-last-col)")
"""
(add-text-data-validation sheet
strings
empty-cell-allowed?
err-title
err-text
region-first-row
region-last-row
region-first-col
region-last-col)
""")
:doc "Adds a text enumeration validation to a cell region in a sheet"
:examples '(
"""
Expand All @@ -895,23 +904,23 @@
"excel/row-height") }

add-text-data-validation [sheet
strings empty-cell-allowed
strings empty-cell-allowed?
err-title err-text
region-first-row region-last-row
region-first-col region-last-col]

{ :pre [(instance-of? :ExcelSheetFacade sheet)
(sequential? strings)
(every? string? strings)
(boolean? empty-cell-allowed)
(boolean? empty-cell-allowed?)
(or (nil? err-title) (string? err-title))
(or (nil? err-text) (string? err-text))
(long? region-first-row) (pos? region-first-row)
(long? region-last-row) (pos? region-last-row)
(long? region-first-col) (pos? region-first-col)
(long? region-last-col) (pos? region-last-col)] }

(. sheet :addTextDataValidation strings empty-cell-allowed
(. sheet :addTextDataValidation strings empty-cell-allowed?
err-title err-text
region-first-row region-last-row
region-first-col region-last-col))
Expand Down Expand Up @@ -985,17 +994,19 @@

(defn
^{ :arglists '(
"(add-line-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
vary-colors?
categories-addr-range
series)")
"""
(add-line-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
vary-colors?
categories-addr-range
series)
""")
:doc
"""
Adds a line chart.
Expand Down Expand Up @@ -1091,19 +1102,21 @@

(defn
^{ :arglists '(
"(add-bar-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
direction-bar?
grouping
vary-colors?
categories-addr-range
series)")
"""
(add-bar-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
direction-bar?
grouping
vary-colors?
categories-addr-range
series)
""")
:doc
"""
Adds a bar chart.
Expand Down Expand Up @@ -1201,16 +1214,18 @@

(defn
^{ :arglists '(
"(add-area-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
categories-addr-range
series)")
"""
(add-area-chart sheet chart-title
chart-addr-range
legend-position
category-axis-title
category-axis-position
value-axis-title
value-axis-position
three-dimensional?
categories-addr-range
series)
""")
:doc
"""
Adds an area chart.
Expand Down Expand Up @@ -1290,13 +1305,15 @@

(defn
^{ :arglists '(
"(add-pie-chart sheet chart-title
chart-addr-range
legend-position
three-dimensional?
vary-colors?
categories-addr-range
series)")
"""
(add-pie-chart sheet chart-title
chart-addr-range
legend-position
three-dimensional?
vary-colors?
categories-addr-range
series)
""")
:doc
"""
Adds a pie chart.
Expand Down

0 comments on commit 3661ccc

Please sign in to comment.