metabase.models.dashboard-card

Liking cljdoc? Tell your friends :D

Clojure only.

create-dashboard-card!
dashboard
DashboardCard
delete-dashboard-card!
retrieve-dashboard-card
series
update-dashboard-card!
update-dashboard-card-series!

create-dashboard-card!^clj

(create-dashboard-card! dashboard-card)

Inputs: [dashboard-card :- NewDashboardCard]

Create a new DashboardCard by inserting it into the database along with all associated pieces of data such as DashboardCardSeries. Returns the newly created DashboardCard or throws an Exception.

Inputs: [dashboard-card :- NewDashboardCard]

Create a new DashboardCard by inserting it into the database along with all associated pieces of data such as
 DashboardCardSeries. Returns the newly created DashboardCard or throws an Exception.

source raw docstring

dashboard^clj

(dashboard {:keys [dashboard_id]})

Return the Dashboard associated with the DashboardCard.

Return the Dashboard associated with the DashboardCard.

source raw docstring

DashboardCard^clj

(DashboardCard)

(DashboardCard id)

(DashboardCard & kvs)

Entity for 'report_dashboardcard' table; instance of DashboardCardInstance.

Entity for 'report_dashboardcard' table; instance of DashboardCardInstance.

source raw docstring

delete-dashboard-card!^clj

(delete-dashboard-card! dashboard-card user-id)

Delete a DashboardCard`

Delete a DashboardCard`

source raw docstring

retrieve-dashboard-card^clj

(retrieve-dashboard-card id)

Inputs: [id :- su/IntGreaterThanZero]

Fetch a single DashboardCard by its ID value.

Inputs: [id :- su/IntGreaterThanZero]

Fetch a single DashboardCard by its ID value.

source raw docstring

series^clj

(series {:keys [id]})

Return the Cards associated as additional series on this DashboardCard.

Return the `Cards` associated as additional series on this DashboardCard.

source raw docstring

update-dashboard-card!^clj

(update-dashboard-card! {:keys [id series parameter_mappings
                                visualization_settings]
                         :as dashboard-card})

Inputs: [{:keys [id series parameter_mappings visualization_settings], :as dashboard-card} :- DashboardCardUpdates]

Update an existing DashboardCard` including all DashboardCardSeries. Returns the updated DashboardCard or throws an Exception.

Inputs: [{:keys [id series parameter_mappings visualization_settings], :as dashboard-card} :- DashboardCardUpdates]

Update an existing DashboardCard` including all DashboardCardSeries.
 Returns the updated DashboardCard or throws an Exception.

source raw docstring

update-dashboard-card-series!^clj

(update-dashboard-card-series! {:keys [id]} card-ids)

Inputs: [{:keys [id]} :- {:id su/IntGreaterThanZero, s/Keyword s/Any} card-ids :- [su/IntGreaterThanZero]]

Update the DashboardCardSeries for a given DashboardCard. card-ids should be a definitive collection of all IDs of cards for the dashboard card in the desired order.

If an ID in card-ids has no corresponding existing DashboardCardSeries object, one will be created.
If an existing DashboardCardSeries has no corresponding ID in card-ids, it will be deleted.
All cards will be updated with a position according to their place in the collection of card-ids

Inputs: [{:keys [id]} :- {:id su/IntGreaterThanZero, s/Keyword s/Any} card-ids :- [su/IntGreaterThanZero]]

Update the DashboardCardSeries for a given DashboardCard.
 `card-ids` should be a definitive collection of *all* IDs of cards for the dashboard card in the desired order.

 *  If an ID in `card-ids` has no corresponding existing DashboardCardSeries object, one will be created.
 *  If an existing DashboardCardSeries has no corresponding ID in `card-ids`, it will be deleted.
 *  All cards will be updated with a `position` according to their place in the collection of `card-ids`

source raw docstring