Viewport

Valid Parents: Page

Valid Children: Domain, Title, Datasheet

Description

The Viewport object's resources allow you to change items such as the size of the viewport (relative to the Page object), the background color, whether the viewport has a frame, and whether the frame is colored.

Viewport resource tabs

Main

Ratios

3D Workbox

Viewport Resources

Viewport Resource Set

Angle in XY Plane (XuNangleInXYPlane)
Available if Projection is set to Perspective. In 3D graphs, the viewing angle is offset 30 degrees by default in the X­Y plane. Changing this value rotates the graph about the Z axis. For example, to see a graph face with the workbox X­axis parallel to the viewing vector, set this value to 0.

  • Type: float
  • Default: 30
  • Range: 0:360

Color (XuNbackgroundColor)
The color for the viewport's background.

  • Type: float
  • Default: Unset
  • Range:

Distance Factor (XuNdistanceFactor)
The factor given is multiplied by the maximum diagonal length of the 3D workbox to determine the distance between the eye point and the focus point, relative to the dimensions of the 3D workbox. By varying this distance the perspective of the 3D graph can be controlled.Relevent only if XuNprojection (Projection) is set to perspective.

  • Type: float
  • Default: 2
  • Range: 1:10

Elevation Angle (XuNelevationPlane)
Available if Projection is set to Perspective. In 3D graphs, the viewing angle is raised from the X­Y plane. The default is 25 degrees. The Angle in XY Plane and the Elevation Angle can also be interactively controlled with MB1. Select the viewport and press the rotate icon in the toolbar. This will bring up a wireframe which is rotated and tilted when the pointer is moved.

  • Type: float
  • Default: 25
  • Range: ­90:90

1st Diagonal Point (XuNfirstDiagonalPoint)
The coordinates for a corner of the current viewport. Alternatively, resize or move the viewport with MB1.

  • Type: float
  • Default: (10,10)
  • Range:

Focus Height (XuNfocusHeight)
Available if Projection is set to Perspective. The focus height is specified as a percentage of the Z­dimension of the 3D workbox. The default focus height is set to 50. The focus width and depth are also set permanently to 50%. This means that the center of the 3D workbox is the focus point and is always placed at the center of the viewport.

  • Type: float
  • Default: 50
  • Range: 0:100

Color (XuNframeColor)
The color of the viewport frame.

  • Type: float
  • Default: 1
  • Range:

Frame (XuNframe)
The priority of the frame surrounding the viewport.

  • Type: string
  • Default: "off"
  • Range: "off", "behind" or "inFront"

Width (XuNframeWidth)
The width of the frame surrounding the viewport.

  • Type: float
  • Default: 0
  • Range: 0:5

Oblique Angle (XuNobliqueAngle)
The angle at which the back plane of the 3D workbox is positioned in relation to the front plane of the 3D workbox.Relevent only if XuNprojection (Projection) is set to oblique.

  • Type: float
  • Default: 45
  • Range: 0:360

Priority (XuNpriority)
This resource sets the drawing priority of the object. By default objects of the same class are drawn in the order of creation. Setting an object's priority repositions it in the drawing sequence.Like objects are drawn in ascending order of priority; the object with the largest priority setting is drawn on the top.

  • Type: float
  • Default: 0
  • Range: ­127:128

Type (XuNprojection)
Determines how depth is represented for 3D graphs. Possible options:

Label Value Description
Perspective "perspective" Uses 3D perspective so that depth is perceived.
Oblique "oblique" An oblique projection (no perspective) is used for the workbox. Oblique projection is useful for creating waterfall graphs.
  • Type: string
  • Default: "perspective"
  • Range: "perspective" ," oblique"

Relative Depth (XuNrelativeDepth)
The distance between the front plane and the back plane of the 3D workbox. Relevant only if XuNprojection (Projection) is set to oblique.

  • Type: float
  • Default: 1
  • Range: ­1:1

2nd Diagonal Point (XuNsecondDiagonalPoint)
The coordinates for a corner diagonally opposed to the 1st point.

  • Type: float
  • Default: (75,80)
  • Range:

Tilt Angle (XuNtiltAngle)
Available if Projection is set to Perspective. The workbox is rotated counterclockwise in the Z plane by the specified value.

  • Type: float
  • Default: 0
  • Range: ­360:360

X Ratio (XuNxRatio)
The X­ratio determines the scaling of a graph placed within the viewport. By default, graphs are scaled to fill the viewport, which may result in unequal scaling of data in the XYZ directions.

  • Type: float
  • Default: Unset
  • Range:

Y Ratio (XuNyRatio)
The Y­ratio determines the scaling of a graph placed within the viewport. By default, graphs are scaled to fill the viewport, which may result in unequal scaling of data in the XYZ directions.

  • Type: float
  • Default: Unset
  • Range:

Z Ratio (XuNzRatio)
The Z­ratio determines the scaling of a graph placed within the viewport. By default, graphs are scaled to fill the viewport, which may result in unequal scaling of data in the XYZ directions.

  • Type: float
  • Default: Unset
  • Range:

Inherited Resources

Controls Resource Set

Destroyable (XuNdestroyable)
This resource controls whether the object can be destroyed by a destroy or reset command. Values can be true (On) to set the object as destroyable, or false (Off) to set the object as permanent.

  • Type: float
  • Default: true
  • Range: false,true

Immutable (XuNimmutable)
This resource controls whether the object can be modified. Values are true (On) for non­modifiable, or false (Off) for modifiable. Setting this resource to true (On) locks the currents settings for the object and disables any further changes to the object, including resetting this resource.

  • Type: float
  • Default: false
  • Range: false,true

Object Name (XuNname)
The name of the object.

  • Type: string
  • Default:
  • Range: N/A

Object Enabled (XuNobjectEnabled)
This resource enables or disables the legend. This resource can be set to either true (On) to enable the object or false (Off) to disabled it.

  • Type: float
  • Default: true
  • Range: false,true

Include in Saved GSL (XuNsave)
This resource controls whether the object is included in saved GSL. Values are true (On) to include the object in saved GSL or false (Off) to omit the object.

  • Type: float
  • Default: true
  • Range: false,true

User Data (XuNuserData)
A dataset name or pointer which the user can associate with the object. The dataset is for user use and will not be used by Gsharp.

  • Type: string
  • Default: Unset
  • Range: N/A

Return to Graphic Objects.