Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

WorkspaceSettings

object

  • displayNamestringrequired

    The authenticated account's display name.

  • instanceNamestringor nullrequired

    The instance's optional name: shown beside the wordmark and as the browser-title tail. Null when the instance is unnamed.

  • viewPrefsobjectrequired

    Per-screen view preferences; slices merge into what is stored, and the read carries every slice written so far.

    • mapsobject

      The Maps list.

      • viewstring

        One of grid, list

      • sortstring

        One of edited, created, name

    • dataobject

      The Data page.

      • viewstring

        One of grid, list

      • sortstring

        One of updated, name, rows, size

    • workflowsobject

      The workflows list.

      • viewstring

        One of grid, list

      • sortstring

        One of edited, created, name

    • projectsobject

      The Projects list.

      • viewstring

        One of grid, list

      • sortstring

        One of updated, name, largest

  • sourceGroupingstringrequireddefault person

    How the SQL console's source list groups datasets: by person (your own, then each other person's under their name and SQL name) or by project. Your own choice, never another account's; person until you choose otherwise.

    One of person, project

  • lookobjectrequired

    Your look, every pick at its kept value or its default; a kept value this version no longer offers reads as its default. It follows you to every browser you sign in to; published pages and exported images keep the default look.

    • colorstringrequireddefault kelp

      Color. The interface's tint: accents, primary buttons, active marks, focus and the background's ink. Never a data color.

      One of kelp, harbor, heather, slate

    • contraststringrequireddefault standard

      Contrast. Borders, dividers and quieter text; more makes them stronger in both themes.

      One of standard, more

    • fontstringrequireddefault inter

      Typeface. The face of everything read: Inter, or the computer's own. Identifiers and values keep the mono face.

      One of inter, system

    • backgroundstringrequireddefault atlantic

      Background. The texture behind the workspace and in the header bar; plain is none.

      One of atlantic, plain, graticule, hex

    • cornersstringrequireddefault rounded

      Corners. Rounded edges of cards, fields, buttons and panels; soft is tighter.

      One of rounded, soft

    • railstringrequireddefault hover

      Side menu. How the side menu opens: on a resting pointer or focus, always open with labels, or icons only.

      One of hover, open, icons

    • panelsstringrequireddefault glass

      Panels. How cards and panels are drawn: frosted glass, liquid glass with a light on its rim, or opaque paper with no blur.

      One of glass, liquid, paper

    • transparencystringrequireddefault clear

      Transparency. How much of the map shows through Liquid's cards and panels: clear, medium or firm. Only while Panels is Liquid.

      One of clear, medium, firm

    No other keys.

Dezfil · Apache-2.0docs from 7439201b