Class: RankSymbol

RankSymbol

符号专题要素基类。

new SuperMap.Feature.Theme.RankSymbol(data, layer, fields, setting, lonlat)

common/overlay/RankSymbol.js, line 4

此类定义了符号专题要素基础模型，具体的图表模型通过继承此类，在子类中实现 assembleShapes 方法。符号专题要素模型采用了可视化图形大小自适应策略，用较少的参数控制着图表诸多图形，图表配置对象的基础属性只有 5 个，它们控制着图表结构、值域范围、数据小数位等基础图表形态。构成图表的图形必须在图表结构里自适应大小。此类不可实例化，此类的可实例化子类必须实现 assembleShapes() 方法。

Name	Type	Description
`data`	SuperMap.Feature.Vector	用户数据，必设参数。
`layer`	SuperMap.Layer.RankSymbol	此专题要素所在图层，必设参数。
`fields`	Array.<string>	data 中的参与此图表生成的字段名称，必设参数。
`setting`	Object	图表配置对象，必设参数。
`lonlat`	SuperMap.LonLat	专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。

Extends

SuperMap.Feature.Theme.Graph

Members

chartBoundsSuperMap.Bounds

图表 Bounds 随着 lonlat、XOffset、YOffset 更新，注意 chartBounds 是图表像素范围，不是地理范围。

chartBoxArray.<number>

专题要素（图表）区域，即图表框，长度为 4 的一维数组，数组的 4 个元素依次表示图表框左端 x 坐标值、下端 y坐标值、右端 x坐标值、上端 y 坐标值；[left, bottom, right, top]。

dataValuesArray.<number>

图表展示的数据值，通过 fields 从数据feature属性中获得。

dataViewBoxArray.<number>

数据视图框，长度为 4 的一维数组，[left, bottom, right, top]。 dataViewBox 是统计专题要素最核心的内容，它负责解释数据在一个像素区域里的数据可视化含义，这种含义用可视化图形表达出来，这些表示数据的图形和一些辅助图形组合在一起构成统计专题图表。

DVBCenterPointArray.<number>

数据视图框中心点，长度为 2 的一维数组，第一个元素表示 x 坐标，第二个元素表示 y 坐标。

DVBCodomainArray.<number>

数据视图框的内允许展示的数据值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限。 dataViewBox 中允许的数据范围，对数据溢出值域范围情况的处理需要在 assembleShapes 中进行。

DVBHeightnumber

数据视图框高度。

DVBOrigonPointArray.<number>

数据视图框原点，数据视图框左上角点，长度为 2 的一维数组，第一个元素表示 x 坐标，第二个元素表示 y 坐标。

DVBParameterArray.<number>

数据视图框参数，长度为 4 的一维数组（数组元素值 >= 0），[leftOffset, bottomOffset, rightOffset, topOffset]，chartBox 内偏距值。此属性用于指定数据视图框 dataViewBox 的范围。

DVBUnitValuestring

单位值。在 assembleShapes() 中初始化其具体意义，例如：饼图的 DVBUnitValue 可以定义为"360/数据总和"，折线图的 DVBUnitValue 可以定义为 "DVBCodomain/DVBHeight"。

DVBWidthnumber

数据视图框宽度。

fieldsArray.<string>

数据{SuperMap.Feature.Vector}属性字段。

heightnumber

专题要素（图表）高度，必设属性。

origonPointArray.<number>

专题要素（图表）原点，图表左上角点像素坐标，是长度为 2 的一维数组，第一个元素表示 x 坐标，第二个元素表示 y 坐标。

origonPointOffsetArray.<number>

数据视图框原点相对于图表框的原点偏移量，长度为 2 的一维数组，第一个元素表示 x 偏移量，第二个元素表示 y 偏移量。

RelativeCoordinatebool

图形是否已经计算了相对坐标。

settingObject

符号配置对象，该对象控制着图表的可视化显示。下面是此配置对象的 5 个基础可设属性：
codomain - {Array} 值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限，必设参数。
XOffset - {number} 专题要素（图表）在 X 方向上的偏移值，单位像素。
YOffset - {number} 专题要素（图表）在 Y 方向上的偏移值，单位像素。
dataViewBoxParameter - {Array} 数据视图框 dataViewBox 参数，它是指图表框 chartBox （由图表位置、图表宽度、图表高度构成的图表范围框）在左、下，右，上四个方向上的内偏距值。
decimalNumber - {number} 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。如果不设置此参数，在取数据值时不对数据做小数位处理。
除了以上 5 个基础属性，此对象的可设属性在不同子类中有较大差异，不同子类中对同一属性的解释也可能不同。请在此类的子类中查看 setting 对象的可设属性和属性含义。

shapeFactorySuperMap.Feature.ShapeFactory

内置的图形工厂对象，调用其 createShape 方法创建图形。

shapeParametersObject

当前图形参数对象，的子类对象。

widthnumber

专题要素（图表）宽度，必设属性。

XOffsetnumber

专题要素（图表）在 X 方向上的偏移值，单位像素。

YOffsetnumber

专题要素（图表）在 Y 方向上的偏移值，单位像素。

Methods

inherited assembleShapes() common/overlay/Graph.js, line 400

图形装配函数。抽象方法，可视化子类必须实现此方法。
重写此方法的步骤：

         1. 图表的某些特殊配置项（setting）处理，例如多数图表模型需要重新指定 dataViewBoxParameter 的默认值。<br>
         2. 调用 initBaseParameter() 方法初始化模型属性值，此步骤必须执行，只有当 initBaseParameter 返回 true 时才可以允许进行后续步骤。<br>
         3. 计算图形参数，制作图形，图形组合。在组装图表过程中，应该特别注意数据视图框单位值的定义、数据值溢出值域范围的处理和图形大小自适应。<br>
         4. 调用 shapesConvertToRelativeCoordinate() 方法，将图形的坐标值转为相对坐标，此步骤必须执行。

Example

//子类实现 assembleShapes() 接口的步骤示例：
 assembleShapes: function(){
   // 第一步：图表的某些特殊配置项（setting）处理，例如多数图表模型需要重新指定 dataViewBoxParameter 的默认值。此步骤是非必须过程。

   // 图表配置对象
   var sets = this.setting;
   // 默认数据视图框，这里展示在使用坐标轴和不使用坐标轴情况下对数据视图框参数赋予不同的默认值
   if(!sets.dataViewBoxParameter){
         if(typeof(sets.useAxis) === "undefined" || sets.useAxis){
             sets.dataViewBoxParameter = [45, 15, 15, 15];
         }
         else{
                 sets.dataViewBoxParameter = [5, 5, 5, 5];
         }
   }

   // 第二步：初始化图表模型基本参数，只有在图表模型基本参数初始化成功时才可模型相关属性，如 this.dataViewBox、 this.DVBCodomain等。此步骤是必须过程。
   if(!this.initBaseParameter()) return;

   // 第三步：用图形组装图表，在组装图表过程中，应该特别注意数据视图框单位值的定义、数据值溢出值域范围的处理和图形大小自适应。
   // 定义图表数据视图框中单位值的含义，下面行代码表示将数据视图框单位值定义为数据视图框高度上每像素代表的数据值
   this.DVBUnitValue =  (this.codomain[1] - this.codomain[0])/this.DVBHeight;
   var uv = this.DVBUnitValue;

   // 图形参数计算代码......

   // 关于图形装配，实际上就是利用图形工程对象 this.shapeFactory 的 createShape() 方法通过图形参数对象创建可视化的图形对象，并把这些图形对象按序添加到模型的图形库（his.shapes）中。下面的代码演示创建一个面图形参数对象，并允许通过图形配置对象设置图形的 style 和 highlightStyle，
   var barParams = new SuperMap.Feature.ShapeParameters.Polygon(poiLists);
   barParams.style = sets.barStyle? sets.barStyle:{fillColor: "lightblue"};
   barParams.highlightStyle = sets.barHoverStyle? sets.barHoverStyle:{fillColor: "blue"};
   // 图形携带数据ID信息
   barParams.refDataID = this.data.id;
   // 创建图形并添加到图表图形数组中
   this.shapes.push(this.shapeFactory.createShape(barParams));

   // 第四步：调用 shapesConvertToRelativeCoordinate() 方法，将图形库（his.shapes）中的图形转为由相对坐标表示的图形，客户端统计专题图模块从结构上要求可视化图形使用相对坐标，assembleShapes() 函数必须在图形装配完成后调用 shapesConvertToRelativeCoordinate() 函数。此步骤是必须过程。
   this.shapesConvertToRelativeCoordinate();
},

destroy() common/overlay/RankSymbol.js, line 59

销毁专题要素。

inherited getLocalXY(lonlat) common/overlay/Graph.js, line 452

地理坐标转为像素坐标。

Name	Type	Description
`lonlat`	SuperMap.Lonlat	带转换的地理坐标。

Returns:

屏幕像素坐标。

initBaseParameter(){boolean} common/overlay/RankSymbol.js, line 69

初始化专题要素（图形）基础参数。在调用此方法前，此类的图表模型相关属性都是不可用的，此方法在 assembleShapes 函数中调用。调用此函数关系到 setting 对象的以下属性
codomain - {Array} 值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限，必设参数。
XOffset - {number} 专题要素（图形）在 X 方向上的偏移值，单位像素。
YOffset - {number} 专题要素（图形）在 Y 方向上的偏移值，单位像素。
dataViewBoxParameter - {Array} 数据视图框 dataViewBox 参数，它是指图形框 chartBox （由图表位置、图表宽度、图表高度构成的图表范围框）在左、下，右，上四个方向上的内偏距值。
decimalNumber - {number} 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。如果不设置此参数，在取数据值时不对数据做小数位处理。

Returns:

Type	Description
boolean	初始化参数是否成功。

inherited resetLinearGradient() common/overlay/Graph.js, line 356

resetLocation中调用图表的相对坐标存在的时候，重新计算渐变的颜色。(目前用于二维柱状图渐变色所以子类实现此方法)

inherited resetLocation(lonlat){Array.<number>} common/overlay/Graph.js, line 327

根据地理位置 lonlat 重置专题要素（图表）位置。

Name	Type	Description
`lonlat`	SuperMap.LonLat	专题要素新的像素中心位置。

Returns:

Type	Description
Array.<number>	新专题要素像素参考位置。长度为 2 的数组，第一个元素表示 x 坐标，第二个元素表示 y 坐标。

inherited shapesConvertToRelativeCoordinate() common/overlay/Graph.js, line 364

将（构成图表）图形的节点转为相对坐标表示，此函数必须且只能在 assembleShapes() 结束时调用。