# PlaneGraphics

#### new Cesium.PlaneGraphics(options)
engine/Source/DataSources/PlaneGraphics.js 35

Describes a plane. The center position and orientation are determined by the containing `Entity`.

Name | Type | Description
--- | --- | ---
`options` | PlaneGraphics.ConstructorOptions | optional Object describing initialization options

##### Demo:

- Cesium Sandcastle Plane Demo

### Members

#### readonly definitionChanged : Event
engine/Source/DataSources/PlaneGraphics.js 68

Gets the event that is raised whenever a property or sub-property is changed or modified.

#### dimensions : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 96

Gets or sets the `Cartesian2` Property specifying the width and height of the plane.

#### distanceDisplayCondition : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 155

Gets or sets the `DistanceDisplayCondition` Property specifying at what distance from the camera that this plane will be displayed.

#### fill : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 104

Gets or sets the boolean Property specifying whether the plane is filled with the provided material.

Default Value: `true`

#### material : MaterialProperty
engine/Source/DataSources/PlaneGraphics.js 112

Gets or sets the material used to fill the plane.

Default Value: `Color.WHITE`

#### outline : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 120

Gets or sets the Property specifying whether the plane is outlined.

Default Value: `false`

#### outlineColor : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 128

Gets or sets the Property specifying the `Color` of the outline.

Default Value: `Color.BLACK`

#### outlineWidth : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 139

Gets or sets the numeric Property specifying the width of the outline.

Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}.

Default Value: `1.0`

#### plane : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 88

Gets or sets the `Plane` Property specifying the normal and distance of the plane.

#### shadows : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 148

Get or sets the enum Property specifying whether the plane casts or receives shadows from light sources.

Default Value: `ShadowMode.DISABLED`

#### show : Property|undefined
engine/Source/DataSources/PlaneGraphics.js 80

Gets or sets the boolean Property specifying the visibility of the plane.

Default Value: `true`

### Methods

#### clone(result) → PlaneGraphics
engine/Source/DataSources/PlaneGraphics.js 166

Duplicates this instance.

Name | Type | Description
--- | --- | ---
`result` | PlaneGraphics | optional The object onto which to store the result.

##### Returns:

The modified result parameter or a new instance if one was not provided.

#### merge(source)
engine/Source/DataSources/PlaneGraphics.js 189

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Name | Type | Description
--- | --- | ---
`source` | PlaneGraphics | The object to be merged into this object.

### Type Definitions

#### Cesium.PlaneGraphics.ConstructorOptions
engine/Source/DataSources/PlaneGraphics.js 8

Initialization options for the PlaneGraphics constructor

##### Properties:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`show` | Property | boolean | <optional> | true | A boolean Property specifying the visibility of the plane.
`plane` | Property | Plane | <optional> |  | A `Plane` Property specifying the normal and distance for the plane.
`dimensions` | Property | Cartesian2 | <optional> |  | A `Cartesian2` Property specifying the width and height of the plane.
`fill` | Property | boolean | <optional> | true | A boolean Property specifying whether the plane is filled with the provided material.
`material` | MaterialProperty | Color | <optional> | Color.WHITE | A Property specifying the material used to fill the plane.
`outline` | Property | boolean | <optional> | false | A boolean Property specifying whether the plane is outlined.
`outlineColor` | Property | Color | <optional> | Color.BLACK | A Property specifying the `Color` of the outline.
`outlineWidth` | Property | number | <optional> | 1.0 | A numeric Property specifying the width of the outline.
`shadows` | Property | ShadowMode | <optional> | ShadowMode.DISABLED | An enum Property specifying whether the plane casts or receives shadows from light sources.
`distanceDisplayCondition` | Property | DistanceDisplayCondition | <optional> |  | A Property specifying at what distance from the camera that this plane will be displayed.

Need help? The fastest way to get answers is from the community and team on the Cesium Forum.