# Screen Oriented Text

![](https://894783789-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LPHXQ1I3gb93zpLrLZf%2Fuploads%2Fgit-blob-63953cc95383417c7b5d8be8aafb6ad4c681f443%2FScreen_Oriented_Text.png?alt=media)

![](https://894783789-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LPHXQ1I3gb93zpLrLZf%2Fuploads%2Fgit-blob-d8b3530414fbbcc6f778a6cd81e012ad27574df5%2FScreen_Oriented_Text.png?alt=media) - [\[source code\]](https://github.com/ladybug-tools/ladybug-grasshopper/blob/master/ladybug_grasshopper/src/LB%20Screen%20Oriented%20Text.py)

Generate screen-oriented text that displays in the Rhino scene as a head-up display (HUD).

This is useful when there are certain summary results or information that should always be displayed on-screen.

### Inputs

* **text \[Required]**

Text string to be displayed in the plane of the screen.

* **leg\_par2d**

Optional 2D LegendParameters from the "LB Legend Parameters 2D" component, which will be used to customize a text in the plane of the screen. Note that only the text\_height, origin\_x and origin\_y inputs of this component affect the placement of the text.

* **font**

An optional text string to specify the font to be used for the text. Examples include "Arial", "Times New Roman", "Courier" (all without quotations). Default is "Arial".

* **color**

An optional color to set the color of the text. If unspecified, it will be black.

* **viewport**

Text for the name of the Rhino viewport to which the 2D screen-oriented text will be rendered. Multiple viewports can be connected to have the text display in several viewports. If unspecified, the text is rendered in all viewports. Acceptable inputs include: Perspective Top Bottom Left Right Front Back any view name that has been saved within the Rhino file

### Outputs


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ladybug.tools/ladybug-primer/components/4_extra/screen_oriented_text.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
