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

Link to this type spreadsheet_data()
spreadsheet_data() :: [String.t]
Link to this type spreadsheet_response()
spreadsheet_response ::
  {:json, map} |
  {:error, Exception.t} |
  no_return
Link to this type state()
state() :: map

State of currently active Google spreadsheet:

%{
    spreadsheet_id => "16Wgt0fuoYDgEAtGtYKF4jdjAhZez0q77UhkKdeKI6B4",
    list_name => nil
}

Link to this section Functions

Link to this function append_row(pid, row_index, column_list, options \\ [])
append_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok

Append row in a spreadsheet after an index.

Link to this function clear_row(pid, row_index, options \\ [])
clear_row(pid, integer, Keyword.t) :: :ok

Clear row in a spreadsheet by index.

Link to this function clear_rows(pid, ranges)
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.

Link to this function clear_rows(pid, ranges, options)
clear_rows(pid, [String.t], Keyword.t) ::
  :ok |
  {:error, Exception.t}
clear_rows(pid, integer, integer) ::
  :ok |
  {:error, Exception.t}
Link to this function clear_rows(pid, row_index_start, row_index_end, options)
clear_rows(pid, integer, integer, Keyword.t) ::
  :ok |
  {:error, Exception.t}
Link to this function fetch(pid, range)
fetch(pid, String.t) ::
  {:ok, spreadsheet_data} |
  {:error, Exception.t}

Granural read by a custom range from a spreadsheet.

Link to this function handle_call(msg, from, state)

Write values in batch based on a ranges schema.

Get spreadsheet internal id.

Link to this function properties(pid)
properties(pid) :: map

Get spreadsheet properties.

Link to this function range(row_from, row_to, column_from, column_to)
range(integer, integer, integer, integer) :: String.t
Link to this function range(row_from, row_to, column_from, column_to, state)
range(integer, integer, integer, integer, state) :: String.t
Link to this function read_row(pid, row_index, options \\ [])
read_row(pid, integer, Keyword.t) ::
  {:ok, spreadsheet_data} |
  {:error, Exception.t}

Read row in a spreadsheet by index.

Link to this function read_rows(pid, ranges)
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.

Link to this function read_rows(pid, ranges, options)
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}
Link to this function read_rows(pid, row_index_start, row_index_end, options)
read_rows(pid, integer, integer, Keyword.t) ::
  {:ok, [spreadsheet_data]} |
  {:error, Exception.t}
Link to this function rows(pid)
rows(pid) :: {:ok, integer} | {:error, Exception.t}

Get total amount of rows in a spreadsheet.

Link to this function start_link(spreadsheet_id, opts)
start_link(String.t, Keyword.t) :: {:ok, pid}
Link to this function write_row(pid, row_index, column_list, options \\ [])
write_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok

Override row in a spreadsheet by index.

Link to this function write_rows(pid, ranges, data)
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.

Link to this function write_rows(pid, ranges, data, options)
write_rows(pid, [String.t], [spreadsheet_data], Keyword.t) :: :ok