authoringInfo

The authoringInfo is an object containing metadata about the authoring process for creating a renderer object. This allows the authoring clients to save specific overridable settings so that next time it is accessed via an authoring client, their selections are remembered. Non-authoring clients can ignore it. Properties for color/size/transparency sliders, theme selection, classification information, and additional properties are saved within this object.

Referenced by: ClassBreaks Renderer, Raster ClassBreaks Renderer, Raster UniqueValue Renderer, Simple Renderer, UniqueValue Renderer

Properties

Property Details
classificationMethod Used for classed color or size. The default value is esriClassifyManual.
Valid values: esriClassifyDefinedInterval, esriClassifyEqualInterval, esriClassifyManual, esriClassifyNaturalBreaks, esriClassifyQuantile, esriClassifyStandardDeviation
colorRamp A colorRamp object is used to specify a range of colors that are applied to a group of symbols.
field1 Contains information about an attribute field relating to Relationship renderers.
field2 Contains information about an attribute field relating to Relationship renderers.
fields An array of string values representing field names used for creating predominance renderers.
focus Optional. Used for Relationship renderer. If not set, the legend will default to being square.
Valid values:
  • HH
  • HL
  • LH
  • LL
lengthUnit Unit used in user interfaces to display world/map sizes and distances
Valid values: centimeters, decimal-degrees, decimeters, feet, inches, kilometers, meters, miles, millimeters, nautical-miles, yards
numClasses Number of classes to be associated with the relationship. Used for Relationship renderer.
standardDeviationInterval Use this property if the classificationMethod is esriClassifyStandardDeviation.
Valid values:
  • 0.25
  • 0.33
  • 0.5
  • 1
type Type: String
Valid values: classedColor, classedSize, dotDensity, predominance, relationship, univariateColorSize
visualVariables An array of visualVariable objects containing additional information needed when authoring the renderer.

Additional information

The authoringInfo object is not required with a renderer. It is only used if rendering was generated using the Scene Viewer rendering tools. All snippets provided below show a portion of what is contained within authoringInfo. Please refer to the sample snippets in the authoringInfo visual variable object for additional help.

Classed Size Renderer (Option 1) Example

{
  "type": "classedSize",
  "classificationMethod": "esriClassifyNaturalBreaks"
}

Classed Size Renderer (Option 2) Example

{
  "type": "classedSize",
  "classificationMethod": "esriClassifyStandardDeviation",
  "standardDeviationInterval": 0.5
}

Classed Color Renderer (Option 1) Example

{
  "type": "classedColor",
  "classificationMethod": "esriClassifyNaturalBreaks"
}

Classed Color Renderer (Option 2) Example

{
  "type": "classedColor",
  "classificationMethod": "esriClassifyStandardDeviation",
  "standardDeviationInterval": 0.5
}

Predominance Renderer Example

{
  "type": "predominance",
  "fields": [
    "COST",
    "DOLLARS",
    "PRICE"
  ]
}

Univariate Color Size Renderer Example

{
  "type": "univariateColorSize",
  "visualVariables": [
    {
      "type": "sizeInfo",
      "minSliderValue": 1,
      "maxSliderValue": 1000
    },
    {
      "type": "colorInfo",
      "minSliderValue": 1,
      "maxSliderValue": 1000,
      "theme": "high-to-low"
    }
  ]
}

Relationship Renderer Example

{
  "classificationMethod": "esriClassifyQuantile",
  "field1": {
    "field": "VOTE_TURNOUT",
    "classBreakInfos": [
      {
        "minValue": 1.0844,
        "maxValue": 54.0946
      },
      {
        "minValue": 54.0946,
        "maxValue": 4083.8235
      }
    ]
  },
  "field2": {
    "field": "MP06026a_B",
    "normalizationField": "TOTPOP_CY",
    "classBreakInfos": [
      {
        "minValue": 0.101322,
        "maxValue": 0.197619
      },
      {
        "minValue": 0.197619,
        "maxValue": 0.266094
      }
    ]
  },
  "focus": "HH",
  "numClasses": 2,
  "type": "relationship"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.