HumanSignal · robot-ci-heartex · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023
diff --git a/docs/source/tags/cube.md b/docs/source/tags/cube.md
@@ -0,0 +1,37 @@
+---
+title: Cube
+type: tags
+order: 405
+is_new: t
+meta_title: Cube Tag for Adding Cube Bounding Box to Images
+meta_description: Customize Label Studio with the Cube tag to add Cube bounding boxes to images for machine learning and data science projects.
+---
+
+The `Cube` tag is used to add a Cube (Bounding Box) to an image without selecting a label. This can be useful when you have only one label to assign to a Cube.
+
+Use with the following data types: image.
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> |  | Name of the element |
+| toName | <code>string</code> |  | Name of the image to label |
+| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of Cube |
+| [fillColor] | <code>string</code> |  | Cube fill color in hexadecimal |
+| [strokeColor] | <code>string</code> | <code>&quot;#f48a42&quot;</code> | Stroke color in hexadecimal |
+| [strokeWidth] | <code>number</code> | <code>1</code> | Width of the stroke |
+| [canRotate] | <code>boolean</code> | <code>true</code> | Whether to show or hide rotation control |
+| [smart] | <code>boolean</code> |  | Show smart tool for interactive pre-annotations |
+| [smartOnly] | <code>boolean</code> |  | Only show smart tool for interactive pre-annotations |
+
+### Example
+
+Basic labeling configuration for adding rectangular bounding box regions to an image
+
+```html
+<View>
+  <Cube name="rect-1" toName="img-1" />
+  <Image name="img-1" value="$img" />
+</View>
+```
diff --git a/docs/source/tags/cubelabels.md b/docs/source/tags/cubelabels.md
@@ -0,0 +1,71 @@
+---
+title: CubeLabels
+type: tags
+order: 406
+is_new: t
+meta_title: Cube Label Tag to Label Cube Bounding Box in Images
+meta_description: Customize Label Studio with the CubeLabels tag and add labeled Cube bounding boxes in images for semantic segmentation and object detection machine learning and data science projects.
+---
+
+The `CubeLabels` tag creates labeled Cubes. Use to apply labels to bounding box semantic segmentation tasks.
+
+Use with the following data types: image.
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> |  | Name of the element |
+| toName | <code>string</code> |  | Name of the image to label |
+| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether you can select one or multiple labels |
+| [maxUsages] | <code>number</code> |  | Maximum number of times a label can be used per task |
+| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
+| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of Cube |
+| [fillColor] | <code>string</code> |  | Cube fill color in hexadecimal |
+| [strokeColor] | <code>string</code> |  | Stroke color in hexadecimal |
+| [strokeWidth] | <code>number</code> | <code>1</code> | Width of stroke |
+| [canRotate] | <code>boolean</code> | <code>true</code> | Show or hide rotation control |
+
+### Sample Results JSON
+
+| Name | Type | Description |
+| --- | --- | --- |
+| original_width | <code>number</code> | width of the original image (px) |
+| original_height | <code>number</code> | height of the original image (px) |
+| image_rotation | <code>number</code> | rotation degree of the image (deg) |
+| value | <code>Object</code> |  |
+| value.x | <code>number</code> | x coordinate of the top left corner before rotation (0-100) |
+| value.y | <code>number</code> | y coordinate of the top left corner before rotation (0-100) |
+| value.width | <code>number</code> | width of the bounding box (0-100) |
+| value.height | <code>number</code> | height of the bounding box (0-100) |
+| value.rotation | <code>number</code> | rotation degree of the bounding box (deg) |
+
+### Example JSON
+```json
+{
+  "original_width": 1920,
+  "original_height": 1280,
+  "image_rotation": 0,
+  "value": {
+    "x": 3.1,
+    "y": 8.2,
+    "width": 20,
+    "height": 16,
+    "rectanglelabels": ["Car"]
+  }
+}
+```
+
+### Example
+
+Basic labeling configuration for applying labels to rectangular bounding boxes on an image
+
+```html
+<View>
+  <CubeLabels name="labels" toName="image">
+    <Label value="Person" />
+    <Label value="Animal" />
+  </CubeLabels>
+  <Image name="image" value="$image" />
+</View>
+```
diff --git a/docs/source/tags/datetime.md b/docs/source/tags/datetime.md
@@ -1,7 +1,7 @@
 ---
 title: DateTime
 type: tags
-order: 405
+order: 407
 ---
 
 The DateTime tag adds date and time selection to the labeling interface. Use this tag to add a date, timestamp, month, or year to an annotation.

diff --git a/docs/source/tags/ellipse.md b/docs/source/tags/ellipse.md
@@ -1,7 +1,7 @@
 ---
 title: Ellipse
 type: tags
-order: 406
+order: 408
 meta_title: Ellipse Tag for Adding Elliptical Bounding Box to Images
 meta_description: Customize Label Studio with ellipse tags to add elliptical bounding boxes to images for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/ellipselabels.md b/docs/source/tags/ellipselabels.md
@@ -1,7 +1,7 @@
 ---
 title: EllipseLabels
 type: tags
-order: 407
+order: 409
 meta_title: Ellipse Label Tag for Labeling Images with Elliptical Bounding Boxes
 meta_description: Customize Label Studio with the EllipseLabels tag to label images with elliptical bounding boxes for semantic image segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/hypertextlabels.md b/docs/source/tags/hypertextlabels.md
@@ -1,7 +1,7 @@
 ---
 title: HyperTextLabels
 type: tags
-order: 408
+order: 410
 meta_title: Hypertext Label Tag to Create Labeled Hypertext (HTML)
 meta_description: Customize Label Studio with the HyperTextLabels tag to label hypertext (HTML) for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/keypoint.md b/docs/source/tags/keypoint.md
@@ -1,7 +1,7 @@
 ---
 title: KeyPoint
 type: tags
-order: 409
+order: 411
 meta_title: Keypoint Tag for Adding Keypoints to Images
 meta_description: Customize Label Studio with the KeyPoint tag to add key points to images for computer vision machine learning and data science projects.
 ---

diff --git a/docs/source/tags/keypointlabels.md b/docs/source/tags/keypointlabels.md
@@ -1,7 +1,7 @@
 ---
 title: KeyPointLabels
 type: tags
-order: 410
+order: 412
 meta_title: Keypoint Label Tag for Labeling Keypoints
 meta_description: Customize Label Studio with the KeyPointLabels tag to label keypoints for computer vision machine learning and data science projects.
 ---

diff --git a/docs/source/tags/label.md b/docs/source/tags/label.md
@@ -1,7 +1,7 @@
 ---
 title: Label
 type: tags
-order: 411
+order: 413
 meta_title: Label Tag for Single Label Tags
 meta_description: Customize Label Studio with the Label tag to assign a single label to regions in a task for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/labels.md b/docs/source/tags/labels.md
@@ -1,7 +1,7 @@
 ---
 title: Labels
 type: tags
-order: 412
+order: 414
 meta_title: Labels Tag for Labeling Regions
 meta_description: Customize Label Studio by using the Labels tag to provide a set of labels for labeling regions in tasks for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/magicwand.md b/docs/source/tags/magicwand.md
@@ -1,7 +1,7 @@
 ---
 title: Magicwand
 type: tags
-order: 413
+order: 415
 meta_title: Magic Wand Tag for Quick Thresholded Flood Filling During Image Segmentation
 meta_description: Customize Label Studio with a Magic Wand tag to quickly click and drag to threshold flood fill image areas during image segmentation labeling for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/number.md b/docs/source/tags/number.md
@@ -1,7 +1,7 @@
 ---
 title: Number
 type: tags
-order: 414
+order: 416
 meta_title: Number Tag to Numerically Classify
 meta_description: Customize Label Studio with the Number tag to numerically classify tasks in your machine learning and data science projects.
 ---

diff --git a/docs/source/tags/object3d.md b/docs/source/tags/object3d.md
@@ -0,0 +1,69 @@
+---
+title: Object3D
+type: tags
+order: 305
+is_new: t
+meta_title: Object3D Tags for Object3Ds
+meta_description: Customize Label Studio with the Object3D tag to annotate object3ds for computer vision machine learning and data science projects.
+---
+
+The `Object3D` tag shows an object3d on the page. Use for all object3d annotation tasks to display an object3d on the labeling interface.
+
+Use with the following data types: object3ds.
+
+When you annotate object3d regions with this tag, the annotations are saved as percentages of the original size of the object3d, from 0-100.
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> |  | Name of the element |
+| value | <code>string</code> |  | Data field containing a path or URL to the object3d |
+| [valueList] | <code>string</code> |  | References a variable that holds a list of object3d URLs |
+| [smoothing] | <code>boolean</code> |  | Enable smoothing, by default it uses user settings |
+| [width] | <code>string</code> | <code>&quot;100%&quot;</code> | Object3D width |
+| [maxWidth] | <code>string</code> | <code>&quot;750px&quot;</code> | Maximum object3d width |
+| [zoom] | <code>boolean</code> | <code>false</code> | Enable zooming an object3d with the mouse wheel |
+| [negativeZoom] | <code>boolean</code> | <code>false</code> | Enable zooming out an object3d |
+| [zoomBy] | <code>float</code> | <code>1.1</code> | Scale factor |
+| [grid] | <code>boolean</code> | <code>false</code> | Whether to show a grid |
+| [gridSize] | <code>number</code> | <code>30</code> | Specify size of the grid |
+| [gridColor] | <code>string</code> | <code>&quot;#EEEEF4&quot;</code> | Color of the grid in hex, opacity is 0.15 |
+| [zoomControl] | <code>boolean</code> | <code>false</code> | Show zoom controls in toolbar |
+| [brightnessControl] | <code>boolean</code> | <code>false</code> | Show brightness control in toolbar |
+| [contrastControl] | <code>boolean</code> | <code>false</code> | Show contrast control in toolbar |
+| [rotateControl] | <code>boolean</code> | <code>false</code> | Show rotate control in toolbar |
+| [crosshair] | <code>boolean</code> | <code>false</code> | Show crosshair cursor |
+| [horizontalAlignment] | <code>left</code> \| <code>center</code> \| <code>right</code> | <code>left</code> | Where to align object3d horizontally. Can be one of "left", "center", or "right" |
+| [verticalAlignment] | <code>top</code> \| <code>center</code> \| <code>bottom</code> | <code>top</code> | Where to align object3d vertically. Can be one of "top", "center", or "bottom" |
+| [defaultZoom] | <code>auto</code> \| <code>original</code> \| <code>fit</code> | <code>fit</code> | Specify the initial zoom of the object3d within the viewport while preserving its ratio. Can be one of "auto", "original", or "fit" |
+| [crossOrigin] | <code>none</code> \| <code>anonymous</code> \| <code>use-credentials</code> | <code>none</code> | Configures CORS cross domain behavior for this object3d, either "none", "anonymous", or "use-credentials", similar to [DOM `img` crossOrigin property](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/crossOrigin). |
+
+### Example
+
+Labeling configuration to display an object3d on the labeling interface
+
+```html
+<View>
+  <!-- Retrieve the object3d url from the url field in JSON or column in CSV -->
+  <Object3D name="object3d" value="$url" rotateControl="true" zoomControl="true"></Object3D>
+</View>
+```
+### Example
+
+Labeling configuration to perform multi-object3d segmentation
+
+```html
+<View>
+  <!-- Retrieve the object3d url from the url field in JSON or column in CSV -->
+  <Object3D name="object3d" valueList="$object3ds" rotateControl="true" zoomControl="true"></Object3D>
+</View>
+<!-- {
+  "data": {
+    "object3ds": [
+      "https://object3ds.unsplash.com/photo-1556740734-7f3a7d7f0f9c?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1950&q=80",
+      "https://object3ds.unsplash.com/photo-1556740734-7f3a7d7f0f9c?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1950&q=80",
+    ]
+  }
+} -->
+```
diff --git a/docs/source/tags/pairwise.md b/docs/source/tags/pairwise.md
@@ -1,7 +1,7 @@
 ---
 title: Pairwise
 type: tags
-order: 415
+order: 417
 meta_title: Pairwise Tag to Compare Objects
 meta_description: Customize Label Studio with the Pairwise tag for object comparison tasks for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/paragraphlabels.md b/docs/source/tags/paragraphlabels.md
@@ -1,7 +1,7 @@
 ---
 title: ParagraphLabels
 type: tags
-order: 416
+order: 418
 meta_title: Paragraph Label Tag for Paragraph Labels
 meta_description: Customize Label Studio with paragraph labels for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/paragraphs.md b/docs/source/tags/paragraphs.md
@@ -1,7 +1,7 @@
 ---
 title: Paragraphs
 type: tags
-order: 305
+order: 306
 meta_title: Paragraph Tags for Paragraphs
 meta_description: Customize Label Studio with the Paragraphs tag to annotate paragraphs for NLP and NER machine learning and data science projects.
 ---

diff --git a/docs/source/tags/polygon.md b/docs/source/tags/polygon.md
@@ -1,7 +1,7 @@
 ---
 title: Polygon
 type: tags
-order: 417
+order: 419
 meta_title: Polygon Tag for Adding Polygons to Images
 meta_description: Customize Label Studio with the Polygon tag by adding polygons to images for segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/polygonlabels.md b/docs/source/tags/polygonlabels.md
@@ -1,7 +1,7 @@
 ---
 title: PolygonLabels
 type: tags
-order: 418
+order: 420
 meta_title: Polygon Label Tag for Labeling Polygons in Images
 meta_description: Customize Label Studio with the PolygonLabels tag and label polygons in images for semantic segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/ranker.md b/docs/source/tags/ranker.md
@@ -1,7 +1,7 @@
 ---
 title: Ranker
 type: tags
-order: 419
+order: 421
 meta_title: Ranker Tag allows you to rank items in a List or, if Buckets are used, pick relevant items from a List
 meta_description: Customize Label Studio by sorting results for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rating.md b/docs/source/tags/rating.md
@@ -1,7 +1,7 @@
 ---
 title: Rating
 type: tags
-order: 420
+order: 422
 meta_title: Rating Tag for Ratings
 meta_description: Customize Label Studio to add ratings to tasks with the Rating tag in your machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rectangle.md b/docs/source/tags/rectangle.md
@@ -1,7 +1,7 @@
 ---
 title: Rectangle
 type: tags
-order: 421
+order: 423
 meta_title: Rectangle Tag for Adding Rectangle Bounding Box to Images
 meta_description: Customize Label Studio with the Rectangle tag to add rectangle bounding boxes to images for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rectanglelabels.md b/docs/source/tags/rectanglelabels.md
@@ -1,7 +1,7 @@
 ---
 title: RectangleLabels
 type: tags
-order: 422
+order: 424
 meta_title: Rectangle Label Tag to Label Rectangle Bounding Box in Images
 meta_description: Customize Label Studio with the RectangleLabels tag and add labeled rectangle bounding boxes in images for semantic segmentation and object detection machine learning and data science projects.
 ---

diff --git a/docs/source/tags/relation.md b/docs/source/tags/relation.md
@@ -1,7 +1,7 @@
 ---
 title: Relation
 type: tags
-order: 423
+order: 425
 meta_title: Relation Tag for a Single Relation
 meta_description: Customize Label Studio by using the Relation tag to add a single consistent label to relations between regions in machine learning and data science projects.
 ---

diff --git a/docs/source/tags/relations.md b/docs/source/tags/relations.md
@@ -1,7 +1,7 @@
 ---
 title: Relations
 type: tags
-order: 424
+order: 426
 meta_title: Relations Tag for Multiple Relations
 meta_description: Customize Label Studio by adding labels to relationships between labeled regions for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/shortcut.md b/docs/source/tags/shortcut.md
@@ -1,7 +1,7 @@
 ---
 title: Shortcut
 type: tags
-order: 425
+order: 427
 meta_title: Shortcut Tag to Define Shortcuts
 meta_description: Customize Label Studio to define keyboard shortcuts and hotkeys to accelerate labeling for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/table.md b/docs/source/tags/table.md
@@ -1,7 +1,7 @@
 ---
 title: Table
 type: tags
-order: 306
+order: 307
 meta_title: Table Tag to Display Keys & Values in Tables
 meta_description: Customize Label Studio by displaying key-value pairs in tasks for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/taxonomy.md b/docs/source/tags/taxonomy.md
@@ -1,7 +1,7 @@
 ---
 title: Taxonomy
 type: tags
-order: 426
+order: 428
 meta_title: Taxonomy Tag for Hierarchical Labels
 meta_description: Customize Label Studio with the Taxonomy tag and use hierarchical labels for machine learning and data science projects.
 ---