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, Dot Density Renderer, Predominance Renderer, Simple Renderer, UniqueValue Renderer

Properties

Property Details
classificationMethod Used for classed color or size. The default value is esriClassifyManual. The esriClassifyDefinedInterval method is only applicable to raster class breaks renderer only.
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
maxSliderValue Optional. Indicates the maximum value of a slider if one was used to generate the dot value for dot density renderer.
minSliderValue Optional. Indicates the minimum value of a slider if one was used to generate the dot value for dot density renderer.
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
statistics Statistics used by the legend to avoid representing data values that are beyond the dataset max and min. Only applies to renderers of type univariateColorSize with an 'above-and-below' univariateTheme.
type Type: String
Valid values: classedColor, classedSize, dotDensity, predominance, relationship, univariateColorSize
univariateSymbolStyle Symbol style or symbol pair used when creating a renderer of type univariateColorSize with an above-and-below univariateTheme. The custom style indicates the renderer uses a custom symbol pair not provided by the authoring application.
Valid values: arrow, caret, circle, circle-arrow, circle-caret, circle-plus-minus, custom, happy-sad, plus-minus, square, thumb, triangle
univariateTheme Theme to be used only when working with renderers of type univariateColorSize.
Valid values:
  • above
  • above-and-below
  • below
  • high-to-low
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 some authoring clients 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

Please see these sample webmaps showing authoringInfo with classed size using natural breaks.

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

Classed Size Renderer (Option 2) Example

Please see these sample webmaps showing authoringInfo with classed size using standard deviation.

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

Classed Color Renderer (Option 1) Example

Please see these sample webmaps showing authoringInfo with classed color using naturl breaks.

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

Classed Color Renderer (Option 2) Example

Please see these sample webmaps showing authoringInfo with classed color using standard deviation.

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

Above and below univariate color and size renderer with binary color set in class break infos. Example

{
  "authoringInfo": {
    "type": "univariateColorSize",
    "visualVariables": [
      {
        "maxSliderValue": 20,
        "minSliderValue": -20,
        "theme": "above-and-below",
        "type": "sizeInfo"
      }
    ],
    "statistics": {
      "min": -5,
      "max": 23.8951
    },
    "univariateSymbolStyle": "arrow",
    "univariateTheme": "above-and-below"
  }
}

Above and below univariate color and size renderer with continuous color ramp. Example

{
  "authoringInfo": {
    "type": "univariateColorSize",
    "visualVariables": [
      {
        "maxSliderValue": 20,
        "minSliderValue": -20,
        "theme": "above-and-below",
        "type": "colorInfo"
      },
      {
        "maxSliderValue": 20,
        "minSliderValue": -20,
        "theme": "above-and-below",
        "type": "sizeInfo"
      }
    ],
    "statistics": {
      "min": -5,
      "max": 23.8951
    },
    "univariateSymbolStyle": "triangle",
    "univariateTheme": "above-and-below"
  }
}

Predominance Renderer Example

Please see these sample webmaps showing authoringInfo with predominance.

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

Relationship Renderer Example

{
  "authoringInfo": {
    "type": "relationship",
    "numClasses": 3,
    "focus": "HH",
    "field1": {
      "field": "MaxWaitTime7_9",
      "classBreakInfos": [
        {
          "minValue": 3,
          "maxValue": 18
        },
        {
          "minValue": 18,
          "maxValue": 32
        },
        {
          "minValue": 32,
          "maxValue": 83
        }
      ]
    },
    "field2": {
      "field": "MINORITYCY",
      "normalizationField": "TOTPOP",
      "classBreakInfos": [
        {
          "minValue": 0,
          "maxValue": 0.674681
        },
        {
          "minValue": 0.674681,
          "maxValue": 0.950943
        },
        {
          "minValue": 0.950943,
          "maxValue": 1
        }
      ]
    }
  }
}

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