Class: Grid

SuperMap.Grid

The UGC grid layer class.

new SuperMap.Grid(options)

Grid.js, line 9
Name Type Description
options Object

The parameters.

Name Type Description
colorDictionary Array.<Object> optional

Color dictionary.
brightness number optional

The brightness of the Grid layer.
colorGradientType SuperMap.ColorGradientType optional

Color gradient enumeration.
colors SuperMap.ServerColor optional

The color table object.
contrast number optional

The contrast of the Grid layer.
gridType SuperMap.GridType optional

Grid type.
horizontalSpacing number optional

The horizontal spacing of the grid.
sizeFixed boolean optional

Sets whether the size of the grid is fixed or not. If not, the grid will zoom with the map zoom.
solidStyle SuperMap.ServerStyle optional

The style of grid solid line.
specialColor SuperMap.ServerColor optional

The color of the no value in the grid dataset.
specialValue number optional

The special value of the layer.
specialValueTransparent boolean optional

Whether the area which has the special value is transparent in the layer.
verticalSpacing number optional

The size of grid vertical spacing.

Extends

Members

boundsSuperMap.Bounds

Layer bounds.

brightnessnumber

The brightness of the Grid layer.

captionstring

The caption of the map layer.

colorDictionarysArray.<SuperMap.ColorDictionary>

Color dictionary.

colorGradientTypeSuperMap.ColorGradientType

Color gradient enumeration.

colorsSuperMap.ServerColor

The color table object.

completeLineSymbolDisplayedboolean

Whether to display a complete line symbol.

contrastnumber

The contrast of the Grid layer.

dashStyleSuperMap.ServerStyle

The color of the special value in the grid dataset.

datasetInfoSuperMap.DatasetInfo

Dataset information.

descriptionstring

The description of the layer.

displayFilterstring

The filter condition for the layer display.

gridTypeSuperMap.GridType

Grid type.

horizontalSpacingnumber

The horizontal spacing of the grid.

joinItemsSuperMap.JoinItem

The joinItem class.

maxScalenumber

The maximum map scale.

minScalenumber

The minimum map scale.

minVisibleGeometrySizenumber

The minimum visible size, in pixels, of the geometry object.

namestring

Layer name.

opaqueRatenumber

The opacity of the layer.

overlapDisplayedboolean

Whether to display the overlapped parts of map objects.

overlapDisplayedOptionsSuperMap.OverlapDisplayedOptions

The options to avoid map overlap. It is valid only if overlapDisplayed is false.

queryableboolean

Whether the object in the layer enables to be queried.

representationFieldstring

The field storing the representation information.

sizeFixedboolean

Sets whether the size of the grid is fixed or not. If not, the grid will zoom with the map zoom.

solidStyleSuperMap.ServerStyle

The style of grid solid line.

specialColorSuperMap.ServerColor

The color of the no value in the grid dataset.

specialValuenumber

The special value of the layer.

specialValueTransparentboolean

Whether the area which has the special value is transparent in the layer.

subLayersArray

Sublayer set.

symbolScalableboolean

Whether allowing the symbol size changes along with the layer zoom.

symbolScalenumber

The natural scale for symbol zoom of the layer.

typeSuperMap.UGCLayerType

Layer type.

ugcLayerTypeSuperMap.LayerType

Layer type.

verticalSpacingnumber

The size of grid vertical spacing.

visibleboolean

Whether to display the overlapped parts of map objects.

Methods

destroy()

Grid.js, line 124

Disposes the resource. The property that references resource is set to null.

fromJson(jsonObject)

Grid.js, line 133

Transform the JSON object on the server to the client object

Name Type Description
jsonObject Object

The JSON object to be converted.

toServerJSONObject()

Grid.js, line 172

Turned to be the JSON object.

Returns:
The JSON object.