Scene (Plotly.NET) | Plotly.NET

Scene Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Scene

Constructors

Constructor	Description
`Scene()` Full Usage: `Scene()` Returns: `Scene`	Returns: `Scene`

Static members

Static member	Description
`Scene.getXAxis scene` Full Usage: `Scene.getXAxis scene` Parameters: scene : `Scene` - The scene to get the x axis from Returns: `LinearAxis`	Returns the x axis object of the given scene. If there is no x axis set, returns an empty LinearAxis object. scene : `Scene` The scene to get the x axis from Returns: `LinearAxis`
`Scene.getYAxis scene` Full Usage: `Scene.getYAxis scene` Parameters: scene : `Scene` - The scene to get the y axis from Returns: `LinearAxis`	Returns the y axis object of the given scene. If there is no y axis set, returns an empty LinearAxis object. scene : `Scene` The scene to get the y axis from Returns: `LinearAxis`
`Scene.getZAxis scene` Full Usage: `Scene.getZAxis scene` Parameters: scene : `Scene` - The scene to get the z axis from Returns: `LinearAxis`	Returns the z axis object of the given scene. If there is no z axis set, returns an empty LinearAxis object. scene : `Scene` The scene to get the z axis from Returns: `LinearAxis`
`Scene.init (?Annotations, ?AspectMode, ?AspectRatio, ?BGColor, ?Camera, ?Domain, ?DragMode, ?HoverMode, ?UIRevision, ?XAxis, ?YAxis, ?ZAxis)` Full Usage: `Scene.init (?Annotations, ?AspectMode, ?AspectRatio, ?BGColor, ?Camera, ?Domain, ?DragMode, ?HoverMode, ?UIRevision, ?XAxis, ?YAxis, ?ZAxis)` Parameters: ?Annotations : `Annotation seq` - An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow. ?AspectMode : `AspectMode` - If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used. ?AspectRatio : `AspectRatio` - Sets this scene's axis aspectratio. ?BGColor : `Color` - Sets this scene's background color. ?Camera : `Camera` - Sets this scene's camera ?Domain : `Domain` - Sets this scene's domain ?DragMode : `DragMode` - Determines the mode of drag interactions for this scene. ?HoverMode : `HoverMode` - Determines the mode of hover interactions for this scene. ?UIRevision : `string` - Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. ?XAxis : `LinearAxis` - Sets this scene's xaxis ?YAxis : `LinearAxis` - Sets this scene's yaxis ?ZAxis : `LinearAxis` - Sets this scene's zaxis Returns: `Scene`	Initialize a categorical Scene object that can be used as a laxout anchor for a 3D coordinate system. ?Annotations : `Annotation seq` An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow. ?AspectMode : `AspectMode` If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used. ?AspectRatio : `AspectRatio` Sets this scene's axis aspectratio. ?BGColor : `Color` Sets this scene's background color. ?Camera : `Camera` Sets this scene's camera ?Domain : `Domain` Sets this scene's domain ?DragMode : `DragMode` Determines the mode of drag interactions for this scene. ?HoverMode : `HoverMode` Determines the mode of hover interactions for this scene. ?UIRevision : `string` Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. ?XAxis : `LinearAxis` Sets this scene's xaxis ?YAxis : `LinearAxis` Sets this scene's yaxis ?ZAxis : `LinearAxis` Sets this scene's zaxis Returns: `Scene`
`Scene.setXAxis xAxis` Full Usage: `Scene.setXAxis xAxis` Parameters: xAxis : `LinearAxis` - The new x axis object Returns: `Scene -> Scene`	Returns a function that sets the x axis object of the given scene. xAxis : `LinearAxis` The new x axis object Returns: `Scene -> Scene`
`Scene.setYAxis yAxis` Full Usage: `Scene.setYAxis yAxis` Parameters: yAxis : `LinearAxis` - The new y axis object Returns: `Scene -> Scene`	Returns a function that sets the y axis object of the given scene. yAxis : `LinearAxis` The new y axis object Returns: `Scene -> Scene`
`Scene.setZAxis zAxis` Full Usage: `Scene.setZAxis zAxis` Parameters: zAxis : `LinearAxis` - The new z axis object Returns: `Scene -> Scene`	Returns a function that sets the z axis object of the given scene. zAxis : `LinearAxis` The new z axis object Returns: `Scene -> Scene`
`Scene.style (?Annotations, ?AspectMode, ?AspectRatio, ?BGColor, ?Camera, ?Domain, ?DragMode, ?HoverMode, ?UIRevision, ?XAxis, ?YAxis, ?ZAxis)` Full Usage: `Scene.style (?Annotations, ?AspectMode, ?AspectRatio, ?BGColor, ?Camera, ?Domain, ?DragMode, ?HoverMode, ?UIRevision, ?XAxis, ?YAxis, ?ZAxis)` Parameters: ?Annotations : `Annotation seq` - An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow. ?AspectMode : `AspectMode` - If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used. ?AspectRatio : `AspectRatio` - Sets this scene's axis aspectratio. ?BGColor : `Color` - Sets this scene's background color. ?Camera : `Camera` - Sets this scene's camera ?Domain : `Domain` - Sets this scene's domain ?DragMode : `DragMode` - Determines the mode of drag interactions for this scene. ?HoverMode : `HoverMode` - Determines the mode of hover interactions for this scene. ?UIRevision : `string` - Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. ?XAxis : `LinearAxis` - Sets this scene's xaxis ?YAxis : `LinearAxis` - Sets this scene's yaxis ?ZAxis : `LinearAxis` - Sets this scene's zaxis Returns: `Scene -> Scene`	Creates a function that applies the given style parameters to a Scene object ?Annotations : `Annotation seq` An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow. ?AspectMode : `AspectMode` If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used. ?AspectRatio : `AspectRatio` Sets this scene's axis aspectratio. ?BGColor : `Color` Sets this scene's background color. ?Camera : `Camera` Sets this scene's camera ?Domain : `Domain` Sets this scene's domain ?DragMode : `DragMode` Determines the mode of drag interactions for this scene. ?HoverMode : `HoverMode` Determines the mode of hover interactions for this scene. ?UIRevision : `string` Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`. ?XAxis : `LinearAxis` Sets this scene's xaxis ?YAxis : `LinearAxis` Sets this scene's yaxis ?ZAxis : `LinearAxis` Sets this scene's zaxis Returns: `Scene -> Scene`
`Scene.tryGetTypedMember propName scene` Full Usage: `Scene.tryGetTypedMember propName scene` Parameters: propName : `string` - The name of the dynamic member to get the value of scene : `Scene` - The scene to get the dynamic member value from Returns: `'T option`	Returns Some(dynamic member value) of the scene object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise. propName : `string` The name of the dynamic member to get the value of scene : `Scene` The scene to get the dynamic member value from Returns: `'T option`