Class: Bar

// The barStyleByCodomain parameter is used as follows:
// Each element of barStyleByCodomain is an object that contains range information and style information corresponding to the range. The object (must) has three attributes:
// start: range lower limit (included).
// end: range upper limit (not included).
// style: Data visualization graphics style, this style object can be set properties: .
// barStyleByCodomain array like：
[
  {
    start:0,
    end:250,
    style:{
         fillColor:"#00CD00"
     }
 },
  {
    start:250,
    end:500,
    style:{
         fillColor:"#00EE00"
     }
 },
  {
    start:500,
    end:750,
    style:{
         fillColor:"#00FF7F"
     }
 },
  {
    start:750,
    end:1500,
    style:{
         fillColor:"#00FF00"
     }
 }
]

Extends

• SuperMap.Feature.Theme.Graph

Members

chartBoundsSuperMap.Bounds

The bounds of the chart will be updated with lonlat, XOffset and YOffset, note: chartBounds is pixel range, not geographical range.

chartBoxArray.<number>

The thematic feature (chart) area, that is, the chart box, a one-dimensional array of length 4, the four elements of the array sequentially represent the x coordinate value at the left end of the chart frame,
the lower y coordinate value, the right end x coordinate value, and the upper y coordinate value; [left , bottom, right, top].

dataObject

{ReadOnly} User data, used to generate visible shape, and can define data format and type in the sub class. e.g.: <SuperMap.Feature.Vector> 。

dataValuesArray.<number>

Data values for representation, got by fields from the property of feature.

dataViewBoxArray.<number>

Data view frame parameters, an array with the length of 4(array element value >= 0), [left, bottom, right, top]. DataViewBox is the core content of the graph theme element. It is responsible for the interpretation of data visualization in a pixel region for the data, and the meaning is expressed by visual graphic. The graphics which represent the data and some auxiliary graphics are combined together to form a statistical thematic charts.

DVBCenterPointArray.<number>

Center of the data view frame, an array with the length of 2, the first one means x, the second one means y.

DVBCodomainArray.<number>

Data domain to show in the data view frame, an array with the length of 2, the first one means the minimum, the second one means the maximum. The processing for the data out of the range should be in assembleShapes.

DVBHeightnumber

Height of the data view frame.

DVBOrigonPointArray.<number>

Origin point of the data view frame, that is the upper left corner point, an array with the length of 2, the first one means x, the second one means y.

DVBParameterArray.<number>

Data view frame parameters, an array with the length of 4(array element value >= 0), [leftOffset, bottomOffset, rightOffset, topOffset], the inner offset value of chartBox. The property is used to specify the range of dataViewBox.

DVBUnitValuestring

Unit value. Initialized in assembleShapes(), e.g.：DVBUnitValue of the pie chart is ”360/data count value”, DVBUnitValue of the line chart is “DVBCodomain/DVBHeight”.

DVBWidthnumber

Width of the data view frame.

fieldsArray.<string>

The data {SuperMap.Feature.Vector} attribute fields.

heightnumber

Height of the theme elements(chart), required.

idstring

Unique identification of thematic elements

layerSuperMap.Layer.Theme

{ReadOnly} Thematic layer where thematic features are.

locationArray

Thematic feature pixel reference position. In general, it is determined by geographic reference. It is an array, the first element is x coordinate, and the second element is y coordinate.

lonlatSuperMap.LonLat

Thematic feature geographic reference position. In sub class, it is assigned by user data (or geographic position parameter).

origonPointArray.<number>

Origin point of the theme elements(chart), that is the upper left corner point, an array with the length of 2, the first one means x, the second one means y.

origonPointOffsetArray.<number>

The origin offset of the data view box relative to the chart box is 2 dimensional array, the first element represents the X offset, and the second element represents the Y offset.

RelativeCoordinateboolean

Whether the figure has been calculated for the relative coordinates.

settingObject

Graph configuration object, which controls the visual display of the graph.

shapeFactorySuperMap.Feature.ShapeFactory

The embedded shape factory object, call its createShape method to create shapes.

shapeParametersObject

The current shape parameter object, the subclass object of <SuperMap.Feature.ShapeParameters>.

shapesArray

{ReadOnly} The visible shape array by thematic features. The order of the array controls the render.

widthnumber

Width of the theme elements(chart), required.

XOffsetnumber

Offset in X direction of the theme elements(chart), the unit is pixel.

YOffsetnumber

Offset in Y direction of the theme elements(chart), the unit is pixel.

Methods

assembleShapes()

Bar.js, line 77

Graphic assembly function.

calculateXShapeInfo(){Object}

Bar.js, line 216

calculate the graphic information on the X axis, this information is an object that contains two properties, property xPositions is a one-dimensional array that represents the pixel coordinates of the pattern in the X axis direction, if the graph has a certain width in the X direction, usually the center point of the graph in the X direction is the coordinate value of the figure in the X direction. width represents the width of the graph (special attention: the width of the point is always 0, not its diameter). graphical configuration object setting in this function can be set to properties: xShapeBlank horizontal direction on the graph blank interval parameters. length for 3 of the array, the first element is the blank space between left of first figure and the left end of the data view box, the second element is the blank space between graphics. third elements that represent the end of the right end of the graph and the blank space between the right end of the data view.

Returns:

Type

Description

Object

If the calculation fails, return null; if successful, return to the X axis direction of the graphics information, this information is an object that contains the following two properties: xPositions - {Array.} said graphics on the X axis coordinates of the pixel value, if graphics in the X direction with a certain width, usually graphics in the X direction the center point of the graphics in the X direction coordinate value. width - {number} width represents the width of the graph (special note: the width of the point is always 0, not its diameter).

inherited constructor(data, layer){SuperMap.Feature.Theme}

Theme.js, line 14

The Constructor.

Name	Type	Description
data	Object	User data which is used to generate visible shape. Required.
layer	SuperMap.Layer.Theme	The layer the theme element is in, required.

Returns:

Type	Description
SuperMap.Feature.Theme	Return a thematic feature.

inherited destroy()

Graph.js, line 208

Destroys thematic features.

inherited destroy()

Graph.js, line 208

Destroys thematic features.

inherited getLocalXY(lonlat)

Graph.js, line 465

The geographic coordinates are converted to pixel coordinates.

Name	Type	Description
lonlat	SuperMap.Lonlat	The geographical coordinates to be converted.

Returns:

Screen pixel coordinates.

inherited initBaseParameter(width, height, codomain, XOffset, YOffset, dataViewBoxParameter, decimalNumber){boolean}

Graph.js, line 238

Initialize the basic parameters of the theme element (chart). Before calling this method, the graph model related properties are not available, this method is called in the assembleShapes function.
The related properties of the setting object are:

Name	Type	Description
width	number	Width of the theme elements(chart), required.
height	number	Height of the theme elements(chart), required.
codomain	Array.<number>	Domain, an array with the length of 2, the first one is the minimum, the second one is the maximum value, required.
XOffset	number	optional Offset in X direction of the theme elements(chart), the unit is pixel.
YOffset	number	optional Offset in Y direction of the theme elements(chart), the unit is pixel.
dataViewBoxParameter	Array.<number>	optional The data view frame dataViewBox parameters, means four inner offset values in left, down, right, up direction of chartBox( constituted by chart position, chart width, chart height).
decimalNumber	number	optional The decimal value of the data value array dataValues, decimal processing parameters, the range is: [0, 16]. If you do not set this parameter, the decimal will not be processed.

Returns:

Type	Description
boolean	Whether the initialization is successful.

resetLinearGradient()

Bar.js, line 277

If the relative coordinate of graph exist, recalculate the colors for gradient.

inherited resetLocation(lonlat){Array.<number>}

Graph.js, line 336

The location of the thematic element (Chart) is reset according to the geographic location lonlat.

Name	Type	Description
lonlat	SuperMap.LonLat	The new pixel center position of the feature element.

Returns:

Type	Description
Array.<number>	New feature element pixel reference position. The length of an array is 2, the first element to represent the X coordinates, the second elements to represent the Y coordinates.

inherited shapesConvertToRelativeCoordinate()

Graph.js, line 375

The node that will (constitute a graph) is converted to relative coordinates, which must be called at the end of the assembleShapes ().

Type Definitions

SuperMap.Feature.Theme.Bar.settingObject

Properties:

Name	Type	Default	Description
width	number		Thematic elements (Graph) width, required parameters.
height	number		Thematic elements (Graph) height, required parameters.
codomain	Array.<number>		Charts allow the display of the data range, the length of two one-dimensional arrays, the first element is range lower limit, the second element is range limit, required parameters.
XOffset	number		optional Thematic elements (graphs) offset value in the X direction, unit pixel.
YOffset	number		optional Thematic elements (graphs) offset value in the Y direction, unit pixel.
dataViewBoxParameter	Array.<number>		optional dataViewBox parameters.It refers to the chartBox (chartBox constituted by chart position, width chart, chart highly) in the left , down,right,up four direction within the offset value. When using the coordinate axis,the default value of dataViewBoxParameter is:[45, 15, 15, 15]； When it is not used,the default value of dataViewBoxParameter is:[5, 5, 5, 5].
decimalNumber	number		optional Data value array dataValues elements of the decimal value, the decimal processing parameters of data, range: [0, 16]. If you do not set this parameter in data value is not a digital data processing.
useBackground	boolean	true	optional Whether to use Background box,default true.
backgroundStyle	SuperMap.Feature.ShapeParameters.Rectangle.style		optional Background style.
backgroundRadius	Array.<number>	[0, 0, 0, 0]	optional Rectangular corner radius of the background frame, you can use the array to specify the four corners of the fillet radius,Set: the radius of upper left, upper right, the second element is the blank space between graphics.third elements that represent the end of the right end of the graph and the blank space between the right end of the data view.
xShapeBlank	Array.<number>		Blank space parameters in horizontal direction. A three length array,the first element is the blank space between left of first figure and the left end of the data view box, the second element is the blank space between graphics.third elements that represent the end of the right end of the graph and the blank space between the right end of the data view.
showShadow	boolean	true	optional Shadow switch.
barShadowStyle	Object		optional Shadow style, such as: {shadowBlur : 8, shadowOffsetX: 2 , shadowOffsetY : 2,shadowColor : "rgba(100,100,100,0.8)"}.
barLinearGradient	Array.<string>		optional Set bar style according to fields [gradient start color, gradient end color], which corresponds to fields in themeLayer.themeFields e.g.：[["#00FF00","#00CD00"],["#00CCFF","#5E87A2"],["#00FF66","#669985"],["#CCFF00","#94A25E"],["#FF9900","#A2945E"]].
useAxis	boolean	true	optional Whether to use axis,default is true.
axisStyle	SuperMap.Feature.ShapeParameters.Line.style		optional Coordinate axis style.
axisUseArrow	boolean	false	optional Whether to use arrow axis.
axisYTick	number	0	optional Y axis scale.
axisYLabels	Array.<string>		optional Label group content on the Y axis, a tag sequence along the data view box left side from top to bottom, equidistant arrangement.For example["1000", "750", "500", "250", "0"].
axisYLabelsStyle	SuperMap.Feature.ShapeParameters.Label.style		optional Y axis on the label group style.
axisYLabelsOffset	Array.<number>	[0,0]	optional The label group offset on the y-axis. An array of length 2, the first item of the array represents the offset in the horizontal direction of the y-axis label group, and is positive to the left. The second item of the array represents the offset in the vertical direction of the y-axis label group, which is positive to the down.
axisXLabels	Array.<string>		optional The contents of the label group on the x-axis. The label order is arranged from left to right along the edge of the data view box, for example: ["92 years", "95 years", "99 years"]. Label arrangement rule: When the number of labels is the same as the number of attributes xShapeCenter in xShapeInfo (that is, when the number of labels is equal to the number of data), arrange the labels according to the position provided by xShapeCenter, otherwise they are arranged equidistantly along the edges below the data view box. label.
axisXLabelsStyle	SuperMap.Feature.ShapeParameters.Label.style		optional X axis on the label group style.
axisXLabelsOffset	Array.<number>	[0,0]	optional The label group offset on the x-axis. An array of length 2, the first item of the array representing the offset in the horizontal direction of the x-axis label group, positive to the left. The second item of the array represents the offset in the vertical direction of the x-axis label group, which is positive to the down.
useXReferenceLine	boolean		optional Whether to use a horizontal reference line, if true, is valid when axisYTick is greater than 0, and the horizontal reference line is the extension of the y-axis scale in the data view box.
xReferenceLineStyle	SuperMap.Feature.ShapeParameters.Line.style		Horizontal guide style.
barStyle	Object		Histogram bar base style, this parameter controls the bar base style, with a lower priority than barStyleByFields and barStyleByCodomain.
barStyleByFields	Array.<SuperMap.Feature.ShapeParameters.Polygon.style>		Set style for bar according to themeFields（SuperMap.Layer.Graph::themeFields）, this parameter field control the bar style,The priority is lower than barStyleByCodomain，and higher than barStyle. The element in this array is a style object, which can be set to a property: <SuperMap.Feature.ShapeParameters.Polygon::style>. The style in this parameter corresponds to the field in the themeFields. such as: themeFields (SuperMap.Layer.Graph::themeFields) is ["POP_1992", "POP_1995", "POP_1999"],barStyleByFields is [style1, style2, style3],barStyleByFields is [style1, style2, style3],in the graph, a column corresponding to the field of POP_1992 using the style1, a POP_1995 field corresponding to the column using the style2 , bar field corresponds to POP_1999 using style3.
barStyleByCodomain	Array.<SuperMap.Feature.ShapeParameters.Polygon.style>		Controls the bar style by the range of values of the data values represented by the bars, with priority over barStyle and barStyleByFields.
barHoverStyle	Object		optional The style of the bar hover state, valid when barHoverAble is true.
barHoverAble	Object		optional Whether to allow the bar to use the hover state, which is allowed by default. Setting barHoverAble and barClickAble to false at the same time directly blocks the response of the bar to the thematic layer event.
barClickAble	Object		optional Whether the bar is allowed to be clicked is allowed by default. Setting barHoverAble and barClickAble to false at the same time directly blocks the response of the bar to the thematic layer event.