elixir_google_spreadsheets v0.1.6 GSS.Spreadsheet
Model of Google Spreadsheet for external interaction.
Maximum size of the supported canvas is 1000 x 26 cells.
Link to this section Summary
Types
State of currently active Google spreadsheet:
%{
spreadsheet_id => "16Wgt0fuoYDgEAtGtYKF4jdjAhZez0q77UhkKdeKI6B4",
list_name => nil
}
Functions
Append row in a spreadsheet after an index
Clear row in a spreadsheet by index
Batched clear, which deletes more then one record. Pass either an array of ranges, or start and end row indexes
Granural read by a custom range from a spreadsheet
Write values in batch based on a ranges schema
Get spreadsheet internal id
Get spreadsheet properties
Read row in a spreadsheet by index
Batched read, which returns more then one record. Pass either an array of ranges (or rows), or start and end row indexes
Get total amount of rows in a spreadsheet
Override row in a spreadsheet by index
Batch update to write multiple rows
Link to this section Types
spreadsheet_response :: {:json, map} | {:error, Exception.t} | no_return
State of currently active Google spreadsheet:
%{
spreadsheet_id => "16Wgt0fuoYDgEAtGtYKF4jdjAhZez0q77UhkKdeKI6B4",
list_name => nil
}
Link to this section Functions
append_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok
Append row in a spreadsheet after an index.
clear_row(pid, integer, Keyword.t) :: :ok
Clear row in a spreadsheet by index.
clear_rows(pid, [String.t]) :: :ok | {:error, Exception.t}
Batched clear, which deletes more then one record. Pass either an array of ranges, or start and end row indexes.
clear_rows(pid, [String.t], Keyword.t) :: :ok | {:error, Exception.t}
clear_rows(pid, integer, integer) :: :ok | {:error, Exception.t}
clear_rows(pid, integer, integer, Keyword.t) :: :ok | {:error, Exception.t}
fetch(pid, String.t) :: {:ok, spreadsheet_data} | {:error, Exception.t}
Granural read by a custom range from a spreadsheet.
Write values in batch based on a ranges schema.
Get spreadsheet internal id.
Get spreadsheet properties.
range(integer, integer, integer, integer) :: String.t
read_row(pid, integer, Keyword.t) :: {:ok, spreadsheet_data} | {:error, Exception.t}
Read row in a spreadsheet by index.
read_rows(pid, [String.t] | [integer]) :: {:ok, [spreadsheet_data | nil]} | {:error, Exception.t}
Batched read, which returns more then one record. Pass either an array of ranges (or rows), or start and end row indexes.
By default it returns nils
for an empty rows,
use pad_empty: true
and column_to: integer
options to fill records
with an empty string values.
read_rows(pid, [String.t] | [integer], Keyword.t) :: {:ok, [spreadsheet_data]} | {:error, Exception.t}
read_rows(pid, integer, integer) :: {:ok, [spreadsheet_data]} | {:error, Exception.t}
read_rows(pid, integer, integer, Keyword.t) :: {:ok, [spreadsheet_data]} | {:error, Exception.t}
Get total amount of rows in a spreadsheet.
write_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok
Override row in a spreadsheet by index.
write_rows(pid, [String.t], [spreadsheet_data]) :: :ok
Batch update to write multiple rows.
Range schema should define the same amount of rows as amound of records in data and same amount of columns as entries in data record.
write_rows(pid, [String.t], [spreadsheet_data], Keyword.t) :: :ok