Render as image

Display a column as an image.

Ingredient Family: customShowIngredientsList

Outline Display: Show the column {{columnName}} as an image with alt text {{altText}}

Local scope

The parent slot binds these (look up the slot in the parent to see how):

  • $table – The table of columns that we want to change the display of

Names introduced within this component’s knobs:

  • inputTable – request shape of endpoint (chosen under apiName)
  • outputTable – response shape of endpoint (chosen under apiName)
  • mappingResult – empty table populated by ingredients

Settings

Required

  • columnName : column of $table (type filter: any type)
    The column to show as an image

  • apiName : API connection
    the API the endpoint is part of
    Set this to the name of any top-level api: item (or the inline api: block on a service/authenticator).

  • endpoint : endpoint of apiName
    the endpoint that will return the url to the image
    Set this to the Name of an entry under wrappedEndpoints: on the referenced api: item, or to the name of a raw endpoints: entry that has no hand-written wrapper: every such endpoint automatically gets an identity wrapper of the same name (each parameter an argument, each response field revealed, with any character other than letters, digits, _, and - in a name replaced by an underscore, so the flattened path payload.note becomes payload_note). Do not write identity wrappers by hand; write a wrappedEndpoints: entry only to restrict or reshape an endpoint, and note that doing so replaces its automatic wrapper.

  • mapping : ingredient slot of mappingIngredientsList($table, mappingResult, inputTable) (many, until inputTable = mappingResult)
    How to map available field values to the endpoint’s inputs

Optional

  • altText : formula (returns text; required, non-nullable)
    the alt text for the image
    Scope: all columns of $table (reference as [ColumnName], e.g., [Name], [Price])

  • widthPx : formula (returns integer; optional)
    the width (in pixels) of the displayed image
    Scope: all columns of $table (reference as [ColumnName], e.g., [Name], [Price])

  • heightPx : formula (returns integer; optional)
    the height (in pixels) of the displayed image
    Scope: all columns of $table (reference as [ColumnName], e.g., [Name], [Price])