From 43fb76f924544a562c560db393dbe82febe35cfb Mon Sep 17 00:00:00 2001 From: Antoine Beyeler Date: Fri, 1 Nov 2024 16:43:15 +0100 Subject: [PATCH] Update the Viewport reference page --- docs/content/reference/viewer/viewport.md | 45 +++++++---------------- 1 file changed, 14 insertions(+), 31 deletions(-) diff --git a/docs/content/reference/viewer/viewport.md b/docs/content/reference/viewer/viewport.md index cd6b30cd763c..bca89785cc9a 100644 --- a/docs/content/reference/viewer/viewport.md +++ b/docs/content/reference/viewer/viewport.md @@ -3,48 +3,31 @@ title: Viewport order: 4 --- -The viewport is a flexible area where you can arrange your Space Views: -You can grab the title of any Space View to dock it to different parts of the viewport or to form tabs. +The viewport is a flexible area where you can arrange your views: +You can grab the title of any view to dock it to different parts of the viewport or to form tabs. -View controls -------------- +## View controls -Clicking on the title of a Space View has the same effect as selecting it in the [Blueprint view](blueprint.md) -and will show additional information & settings in the [Selection view](selection.md) or other means. +Clicking on the title of a view has the same effect as selecting it in the [blueprint panel](blueprint.md) +and will show additional information and settings in the [selection panel](selection.md). -For more information on how to navigate a specific Space View, hover its help icon at the top right corner. +For more information on how to navigate within a specific view, hover its help icon in the top right corner. -The maximize button makes a single Space View fill the entire viewport. -Only one Space view can be maximized at a time. +The maximize button makes a single view fill the entire viewport. +Only one view can be maximized at a time. -Space View Classes ---------------------------- -Rerun distinguishes various Space Views classes: +## View classes -* 2D - * General 2D content like images, lines, points, boxes, etc. -* 3D - * 3D scene with cameras, meshes, points, lines etc. -* Tensor - * Tensor view with support for arbitrary dimensionality. -* Text log - * Text over time. -* Text Document - * Shows a single markdown or raw text document. -* Time series plot - * Scalars over time. -* Bar chart - * Bar-chart lots made from 1D tensor data. -* Dataframe - * Displays any data in a tabular form. +Rerun includes multiple view classes, each dedicated to a specific type of visualization; for example, a 3D scene or a timeseries plot. +See the [views reference page](../types/views.md) for a list of available view classes. -Which class is used is determined upon creation of a Space View. +The view class, which is specified upon creation, determines which entities it can display, how it displays them, and the way they can be interacted with. +Views can be created both from viewer and from code (see [Configure the Viewer through code](../../howto/configure-viewer-through-code.md)). -The Space View class determines which Entities it can display, how it displays them and the way they can be interacted with. -To learn more about the _internals_ of how Space View classes work, check the [guide on Viewer extensions](../../howto/extend.md). +To learn more about the _internals_ of how view classes work, check the [guide on implementing custom views](../../howto/extend/extend-ui.md).