AuthoringInfo Visual Variable

This visual variable pertains specifically to authoringInfo and is different from visual variables directly on the renderer.

Referenced by: authoringInfo

Properties

Property	Details
endTime	A Unix stamp. Both startTime or endTime can be fields. If this is the case, their names must be different.
field	The attribute field the user chose in the Smart Mapping gallery. Applies to age renderer or reference size visualizations (i.e. when theme is reference-size). For age renderer, this value must also be specified in either startTime or endTime. This property is used for UI purposes only.
maxSliderValue	A numeric value indicating the maximum value displayed.
minSliderValue	A numeric value indicating the minimum value displayed.
normalizationField	Only applicable when theme is reference-size. Indicates the attribute field the user chose in the Smart Mapping gallery for normalizing data in the selected field. This property is used for UI purposes only.
referenceSizeScale	The view scale value at which the reference size symbol was created. At this scale value, the sizes persisted in sizeStops are used to render the reference size symbols in the map. At other view scales, the effective sizes in sizeStops will scale proportionally (based on this value) to avoid symbol overlap and maintain a consistent visualization.
referenceSizeSymbolStyle	Only applicable when theme is reference-size. This value specifies the style (or shape) of the symbols generated with a reference line. Typically, a reference line is used to visualize the maximum possible size (i.e. data value) of a data-driven proportional symbol. Visualizations with a reference size must be defined in a ClassBreaksRenderer or UniqueValueRenderer with a CIMSymbol containing two symbol layers: one visualizing the maximum size of the symbol as a hollow ring, and the other as a solid shape whose size is driven by a data value set in the renderer's field property, and configured in a primitive override of the CIMSymbol. These renderers must not contain size visual variables, but may contain other visual variable types. This property is used for UI purposes only. When defined, AuthoringInfoVisualVariable.sizeStops must also be defined for the legend to properly represent the visualization. Valid values: circle diamond hexagon-flat hexagon-pointy square
sizeStops[]	An array of objects that defines the thematic size ramp for a size-based visualization with a reference-size size variable. At least two stops are required. The stops must be listed in ascending order based on the value of the value property in each stop. This property is required when theme is reference-size for the legend to properly render the size reference symbol style along with its labels.
startTime	A Unix time stamp. Both startTime or endTime can be fields. If this is the case, their names must be different.
style	It is used to map the ratio between two numbers. It is possible to express that relationship as percentages, simple ratios, or an overall percentage. Valid values: percent percentTotal ratio
theme	Theme to be used only when working with visual variables of type colorInfo or sizeInfo. Default is high-to-low. The centered-on, and extremes themes only apply to colorInfo visual variables. Valid values: above, above-and-below, below, centered-on, extremes, high-to-low, reference-size
type	A string value specifying the type of renderer's visual variable. Valid values: colorInfo rotationInfo sizeInfo transparencyInfo
units	Units for startTime and endTime. Valid values: days, hours, minutes, months, seconds, years

Attribute Transparency Example

Allows displaying features with different levels of transparency. Please see this listing of webmaps using authoringInfo visual variables with transparency.

{
  "type": "transparencyInfo",
  "minSliderValue": 0.0003,
  "maxSliderValue": 23.8951
}

Continuous Size Renderer Example

Allows displaying features with different sizes of markers. Note: If a layer contains date values, it is possible to use a sequence of proportional symbols to view dates sequentially on a map. Please see this listing of webmaps using authoringInfo visual variables with size.

{
  "type": "sizeInfo",
  "minSliderValue": 1,
  "maxSliderValue": 14928.5396
}

Continuous Color Renderer Example

Allows displaying features with different sizes of markers. Note: If a layer contains date values, it is possible to use color to view data sequentially from new to old or before and after a key date. Please see this listing of webmaps using authoringInfo visual variables with color.

{
  "type": "colorInfo",
  "minSliderValue": 1,
  "maxSliderValue": 14928.5396,
  "theme": "high-to-low"
}

Age-Size Renderer Example

If a layer contains date or time values, it is possible to use a sequence of proportional symbols to view the age of features. Age reflects the length of time (in seconds, minutes, hours, days, months, or years) from a start date or time to an end date or time. Please see this listing of webmaps using authoringInfo visual variables using size and age.

{
  "type": "sizeInfo",
  "minSliderValue": -129.2625,
  "maxSliderValue": 234.7374,
  "units": "days",
  "startTime": "DATE",
  "endTime": 1471970511924,
  "field": "DATE"
}

Age-Color Renderer Example

If a layer contains date or time values, it is possible to use color to represent the age of features. Age reflects the length of time (in seconds, minutes, hours, days, months, or years) from a start date or time to an end date or time. Please see this listing of webmaps using authoringInfo visual variables using color with age.

{
  "type": "colorInfo",
  "minSliderValue": -129.2625,
  "maxSliderValue": 234.7374,
  "units": "days",
  "startTime": "DATE",
  "endTime": 1471970511924,
  "field": "DATE",
  "theme": "high-to-low"
}

Compare Renderer (special color renderer) Example

This style allows mapping the ratio between two numbers and expresses that relationship as percentages, simple ratios, or overall percentage. Please see this listing of webmaps using authoringInfo visual variables using color for comparison.

{
  "type": "colorInfo",
  "minSliderValue": 0.0003858501658018686,
  "maxSliderValue": 23.89513157894737,
  "theme": "above-and-below",
  "style": "ratio"
}

Predominance Renderer Example

This style uses color to show which attribute is predominant, then transparency to show the degree predominance of the attribute for each feature in the layer. The strength, or degree, of predominance is calculated as a percentage of the total value of all the attributes for a given feature. Please see this listing of webmaps showing how authoringInfo can set predominance through the use of transparency.

{
  "type": "predominance",
  "fields": [
    "COST",
    "DOLLARS",
    "PRICE"
  ],
  "visualVariables": [
    {
      "type": "transparencyInfo",
      "minSliderValue": 0,
      "maxSliderValue": 100
    }
  ]
}

Size above theme Example

Sets the min size at a meaningful middle data value to show size variation only in values above the mid point.

{
  "visualVariables": [
    {
      "maxSliderValue": 77.61989,
      "minSliderValue": -100,
      "theme": "above",
      "type": "sizeInfo"
    }
  ]
}

Reference size Example

{
  "visualVariables": [
    {
      "field": "Avg_Population",
      "theme": "reference-size",
      "referenceSizeSymbolStyle": "circle",
      "maxSliderValue": 100,
      "minSliderValue": 0,
      "sizeStops": [
        {
          "value": 0,
          "size": 1
        },
        {
          "value": 100,
          "size": 30
        }
      ],
      "type": "sizeInfo"
    }
  ]
}