XLBC functions

config

xlbc_check_license(license_key)

Register and activate XLbroadcaster addin for Excel

xlbc_version()

Returns XLbroadcaster addin version

callers

xlbc_get()

xlbc_get(url, data_range, result_cell, active, show_cols, filter_key)
To send an HTTP GET request to url with data payload, returns result in result_cell

url
URL to request. Starts with http:// or https:// (otherwise requested URL is BASE_URL + url, see Config file)

data_range
2 columns data range (keys in col1 and values in col2), used to pass arguments as data to requested URL

result_cell
Optional if result is a scalar, otherwise must be top-left cell of result range.

active
0 or 1 (optional, default 1), deactivate the function and stop requesting.
Usually a reference to another call.
Prevents any future update; used if a result must be kept.

show_cols
0 or 1 (optional, default 1), force result column names to be shown/hidden

filter_key
string (optional, default None), show only value for a specific key if result is a dictionary.

xlbc_post()

Same as xlbc_get(), except that HTTP request method is POST.

xlbc_rt()

xlbc_xlrange()

xlbc_xlrange(url, data_range, result_cell, active)
De facto function to exchange Excel data range to another Excel spreadsheet. url Use dbc:// shorthand to read or write on channel: dbc://read/ or dbc://write/

data_range
Define here the data range you want to send to the channel.

result_cell
Optional if result is a scalar, otherwise must be top-left cell of result range.

active
0 or 1 (optional, default 1), deactivate the function and stop requesting. Usually a reference to another call. Prevents any future update; used if a result must be kept.

helpers

from_col/cols/row/rows helpers convert Excel range to JSON string, making it easy to send in requests as data.
from_json performs the reverse action, converting a JSON string and formatting it on Excel.

xlbc_from_col(range)

Creates a list of values (JSON array) from a data range, reference by column.
Used to pass multiple values to a single key name when performing a request.

xlbc_from_cols(range)

Creates a matrix of values (JSON array of arrays) from a data range, matrix seen by cols.
Used to pass multiple values to a single key name when performing a request.

xlbc_from_json(cell)

Format to Excel cells a JSON string.

xlbc_from_row(range)

Creates a list of value (JSON array) from a data range, reference by row.
Used to pass multiple values to a single key name when performing a request.

xlbc_from_rows(range)

Creates a list of value (JSON array) from a data range, matrix seen by rows.
Used to pass multiple values to a single key name when performing a request.