# GridMaterialProperty

#### new Cesium.GridMaterialProperty(options)
engine/Source/DataSources/GridMaterialProperty.js 29

A `MaterialProperty` that maps to grid `Material` uniforms.

Name | Type | Description
--- | --- | ---
`options` | object | optional Object with the following properties:
Name | Type | Default | Description
--- | --- | --- | ---
`color` | Property | Color | `Color.WHITE` | optional A Property specifying the grid `Color`.
`cellAlpha` | Property | number | `0.1` | optional A numeric Property specifying cell alpha values.
`lineCount` | Property | Cartesian2 | `new Cartesian2(8, 8)` | optional A `Cartesian2` Property specifying the number of grid lines along each axis.
`lineThickness` | Property | Cartesian2 | `new Cartesian2(1.0, 1.0)` | optional A `Cartesian2` Property specifying the thickness of grid lines along each axis.
`lineOffset` | Property | Cartesian2 | `new Cartesian2(0.0, 0.0)` | optional A `Cartesian2` Property specifying starting offset of grid lines along each axis.

### Members

#### cellAlpha : Property|undefined
engine/Source/DataSources/GridMaterialProperty.js 101

Gets or sets the numeric Property specifying cell alpha values.

Default Value: `0.1`

#### color : Property|undefined
engine/Source/DataSources/GridMaterialProperty.js 93

Gets or sets the Property specifying the grid `Color`.

Default Value: `Color.WHITE`

#### readonly definitionChanged : Event
engine/Source/DataSources/GridMaterialProperty.js 81

Gets the event that is raised whenever the definition of this property changes. The definition is considered to have changed if a call to getValue would return a different result for the same time.

#### readonly isConstant : boolean
engine/Source/DataSources/GridMaterialProperty.js 60

Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.

#### lineCount : Property|undefined
engine/Source/DataSources/GridMaterialProperty.js 109

Gets or sets the `Cartesian2` Property specifying the number of grid lines along each axis.

Default Value: `new Cartesian2(8.0, 8.0)`

#### lineOffset : Property|undefined
engine/Source/DataSources/GridMaterialProperty.js 125

Gets or sets the `Cartesian2` Property specifying the starting offset of grid lines along each axis.

Default Value: `new Cartesian2(0.0, 0.0)`

#### lineThickness : Property|undefined
engine/Source/DataSources/GridMaterialProperty.js 117

Gets or sets the `Cartesian2` Property specifying the thickness of grid lines along each axis.

Default Value: `new Cartesian2(1.0, 1.0)`

### Methods

#### equals(other) → boolean
engine/Source/DataSources/GridMaterialProperty.js 193

Compares this property to the provided property and returns `true` if they are equal, `false` otherwise.

Name | Type | Description
--- | --- | ---
`other` | Property | optional The other property.

##### Returns:

`true` if left and right are equal, `false` otherwise.

#### getType(time) → string
engine/Source/DataSources/GridMaterialProperty.js 134

Gets the `Material` type at the provided time.

Name | Type | Description
--- | --- | ---
`time` | JulianDate | The time for which to retrieve the type.

##### Returns:

The type of material.

#### getValue(time, result) → object
engine/Source/DataSources/GridMaterialProperty.js 147

Gets the value of the property at the provided time.

Name | Type | Default | Description
--- | --- | --- | ---
`time` | JulianDate | `JulianDate.now()` | optional The time for which to retrieve the value. If omitted, the current system time is used.
`result` | object |  | optional The object to store the value into, if omitted, a new instance is created and returned.

##### Returns:

The modified result parameter or a new instance if the result parameter was not supplied.

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