Getting Started with Juicebox

• Getting Started
  • Getting Oriented
    • What is Juicebox?
    • The Basics
  • Setup & Running on Mac & Linux
    • Setup (Recent MacOS)
    • Setup (Legacy)
    • Running
    • Troubleshooting
  • Setting up Devlandia on Windows
    • What you'll need
    • Install Prerequisite Software
    • Upgrading python
    • Install Docker for Windows
    • Setting up Devlandia
  • Tutorial
    • Before We Begin
    • Part 1 - Getting to know Juicebox
    • Part 2 - Folder Structure & App Configuration
    • Part 3 - Building Data Services
    • Part 4 - Building the Slices
  • Juicebox Glossary

Apps, Stacks & Slices Reference

Learn how to build the core components of Juicebox.

• Apps, Stacks & Slices
  • The Juicebox File Layout
    • Version 3
    • Version 4
    • Converting from version 3 to version 4
  • Apps
    • app.yaml Options
    • Footer
  • Stacks
    • Structure of a stack
    • stack.yaml options
  • Slices
    • Defining Slices
    • Common configuration options for all slices
    • Slice Side Panel
    • Templates
    • Global Filters (DEPRECATED)
    • Custom
    • Vega
    • Grouping Slices
    • Moving easily between stories, aka The Story Chooser Slice
  • Slice Reference
    • Global Filters (DEPRECATED)
    • Bubble
    • Card Slice
    • Distribution
    • Flower
    • Free Form
    • Key Metrics Hierarchy
    • Leaderboard
    • Lollipop
    • Matchup
    • Map
    • Nine Box
    • Option Chooser
    • Orbit
    • Ranked List (DEPRECATED)
    • Ranked List v2
    • Sankey
    • Table
    • Trend
    • Timeseries
    • Built-in slices
  • Ingredients
    • Fields
    • Aggregations
    • Conditions
    • Field Math
    • Combining & Nesting
    • Metrics
    • Performing safe division
    • Referring to other metrics
    • Dimensions
    • Named Formats
    • Icons

How to Style and Format Data

Make your story useful and inviting with styling and formatting

• Styling & Formatting
  • App theme.yaml file
    • Theme.yaml Options
    • Recommended Fonts
  • Applying Backgrounds to Stacks and Slices
    • Styling Backgrounds
    • Layering multiple backgrounds
  • Styling Slices & Sections
    • Styling Slices
    • Grouping Slices into Sections

Providing Help & Guidance to Users

Help your users understand your data with help, tours, and notes.

• Providing Help & Guidance
  • Help in Juicebox
    • Enabling help
    • Building help
  • Tours
    • Enabling stack tours
    • Building stack tours
    • Triggering tours from slices

Interactivity with Discussions & Commands

• Interactivity
  • Discussions
  • Commands
    • Writing app commands
    • Meta options
    • Built-in commands
    • Configuring commands

Handling Data, Users and Permissions

Controlling access to data and delivering it to your users.

• Data, Users, and Permissions
  • Data
    • Providing Data to Slices
    • Renderers
    • Building Recipes
    • Anonymizing Ingredients
    • Number formatting
  • Users and Clients
    • Juicebox Users
    • Setting Up Clients
    • Client and App Admins
    • Client Dashboard

Juicebox APIs

Automating access to Juicebox

• APIs
  • Client Admin API
    • Authentication
    • Clients
    • Sites
    • Users
    • Apps API
  • Saved Global Filters API
    • Get a List of Saved Global Filter Hashes for the Current User
    • Get a List of Saved Global Filter Hashes for the Current User by Stack
    • Get a specific Saved Global Filter Hash for the Current User
    • Creating a Saved Global Filter Hash for the Current User
    • Deleting specific Saved Global Filter Hash for the Current User
    • Updating specific Saved Global Filter Hash for the Current User
  • Fetch and Load Juicebox Apps API
    • Fetch a Juicebox App
    • Load a Juicebox App
  • Juicebox Environment Information API
    • Get information about the running Juicebox environment

Extras

Additional topics

• More Topics
• Release Notes

Operations

• Operating Juicebox
  • Browser Support

Contributing

• How to Contribute
  • Tips for working with restructured text
  • Improving the docs
  • Todos

Indices and tables

• Index
• Module Index
• Search Page