Description
A renderer based on class breaks.
A class breaks renderer symbolizes each graphic or feature based on the value of some numeric attribute. Graphics and features with similar values for the attribute get the same symbol. The "breaks" define the values at which the symbology changes.
For example, suppose you have a "buildings" layer with an attribute that defines the building age. You want to symbolize buildings constructed since the year 2000 in green, buildings constructed between 1980 and 2000 in yellow, and buildings built before 1980 with red. This would be a good scenario for class breaks renderer.
Any value that is greater than or equal to the minimum will be included in the break. Any value that is less than the maximum will be included in the break.
- Since
- 100
Instance Methods | |
| (instancetype) | - initWithFieldName:classBreaks: |
| (BOOL) | - isEqualToRenderer: |
| (AGSSymbol *) | - symbolForFeature: |
| (AGSSymbol *) | - symbolForFeature:applyAttributeOverrides: |
| (AGSSymbol *) | - symbolForGraphic: |
| (AGSSymbol *) | - symbolForGraphic:applyAttributeOverrides: |
| (nullable id) | - toJSON: |
Class Methods | |
| (instancetype) | + classBreaksRenderer |
| (instancetype) | + classBreaksRendererWithFieldName:classBreaks: |
| (nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
| AGSSymbol * | backgroundFillSymbol |
| NSArray< AGSClassBreak * > * | classBreaks |
| AGSRendererClassificationMethod | classificationMethod |
| NSString * | defaultLabel |
| AGSSymbol * | defaultSymbol |
| NSString * | fieldName |
| double | minValue |
| NSString * | normalizationField |
| double | normalizationTotal |
| AGSRendererNormalizationType | normalizationType |
| NSString * | rotationExpression |
| AGSRotationType | rotationType |
| AGSRendererSceneProperties * | sceneProperties |
| NSDictionary< NSString *, id > * | unknownJSON |
| NSDictionary< NSString *, id > * | unsupportedJSON |
Method Documentation
◆ classBreaksRenderer
| + (instancetype) classBreaksRenderer |
Initialize a class breaks renderer.
- Returns
- A new class breaks renderer.
- Since
- 100
◆ classBreaksRendererWithFieldName:classBreaks:
| + (instancetype) classBreaksRendererWithFieldName: | (NSString *) | fieldName | |
| classBreaks: | (NSArray< AGSClassBreak * > *) | classBreaks | |
Initialize a class breaks renderer with a field name and an array of class breaks.
- Parameters
-
fieldName name of the field to apply the class breaks to classBreaks array of class breaks
- Returns
- A new class breaks renderer.
- Since
- 100
◆ fromJSON:error:
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
- Parameters
-
JSONObject NSDictionaryorNSArraycontaining the JSON.error encountered during the operation, if any.
- Since
- 100
◆ initWithFieldName:classBreaks:
| - (instancetype) initWithFieldName: | (NSString *) | fieldName | |
| classBreaks: | (NSArray< AGSClassBreak * > *) | classBreaks | |
Initialize a class breaks renderer with a field name and an array of class breaks.
- Parameters
-
fieldName name of the field to apply the class breaks to classBreaks array of class breaks
- Returns
- A new class breaks renderer.
- Since
- 100
◆ isEqualToRenderer:
| - (BOOL) isEqualToRenderer: | (AGSRenderer *) | other |
Compares two renderers for equality.
- Parameters
-
other renderer to compare this one to.
- Returns
YESifotheris equal toself, otherwiseNO.
- Since
- 100
◆ symbolForFeature:
| - (AGSSymbol*) symbolForFeature: | (AGSFeature *) | feature |
Creates a symbol for the feature based on the scheme used by this renderer.
- Parameters
-
feature The feature to determine the symbol for.
- Returns
- A new symbol for the
feature.
- Since
- 100
◆ symbolForFeature:applyAttributeOverrides:
| - (AGSSymbol*) symbolForFeature: | (AGSFeature *) | feature | |
| applyAttributeOverrides: | (BOOL) | applyAttributeOverrides | |
Creates a symbol for the feature based on the scheme used by this renderer and optionally apply attribute overrides.
If applyAttributeOverrides is set to YES and renderer contains an override expression, this method will return a symbol modified by the expression. If the expression cannot be properly evaluated due to missing fields or external data, then the original symbol is returned.
- Parameters
-
feature The feature to determine the symbol for. applyAttributeOverrides If set YES, applies the override attributes from the renderer.
- Returns
- A symbol for the
feature.
- Since
- 105
◆ symbolForGraphic:
| - (AGSSymbol*) symbolForGraphic: | (AGSGraphic *) | graphic |
Creates a symbol for the graphic based on the scheme used by this renderer.
- Parameters
-
graphic The graphic to determine the symbol for.
- Returns
- A symbol for the
graphic.
- Since
- 100
◆ symbolForGraphic:applyAttributeOverrides:
| - (AGSSymbol*) symbolForGraphic: | (AGSGraphic *) | graphic | |
| applyAttributeOverrides: | (BOOL) | applyAttributeOverrides | |
Creates a symbol for the graphic based on the scheme used by this renderer and optionally apply attribute overrides.
- Parameters
-
graphic The graphic to determine the symbol for. applyAttributeOverrides If set YES, applies the override attributes from the renderer.
- Returns
- A symbol for the
graphic.
- Since
- 100.5
◆ toJSON:
|
requiredinherited |
Returns JSON representation for this object.
- Parameters
-
error encountered during the operation, if any.
- Returns
NSDictionaryorNSArraycontaining the JSON.
- Since
- 100
Reimplemented in AGSPortalItem.
Property Documentation
◆ backgroundFillSymbol
|
readwritenonatomicstrong |
The renderer's background fill symbol
- Since
- 100.1
◆ classBreaks
|
readwritenonatomiccopy |
A collection of class breaks defined for the renderer. The breaks are an array of AGSClassBreak objects.
- Since
- 100
◆ classificationMethod
|
readnonatomicassign |
The classification method used to generate class breaks.
- Since
- 100.2
◆ defaultLabel
|
readwritenonatomiccopy |
The default label if the values does not fall into any of the class breaks.
- Since
- 100
◆ defaultSymbol
|
readwritenonatomicstrong |
The symbol to use if the value does not fall into any of the class breaks.
- Since
- 100
◆ fieldName
|
readwritenonatomiccopy |
Attribute field used by renderer to match values. This must be a key from the attributes collection of the graphic.
- Since
- 100
◆ minValue
|
readwritenonatomicassign |
The minimum value for this class breaks renderer.
- Since
- 100
◆ normalizationField
|
readwritenonatomiccopy |
The normalization field.
- Since
- 100
◆ normalizationTotal
|
readwritenonatomicassign |
The normalization total for this class breaks renderer. Used when normalizationType is AGSNormalizationTypeByPercentOfTotal.
- Since
- 100
◆ normalizationType
|
readwritenonatomicassign |
The normalization type.
- Since
- 100
◆ rotationExpression
|
readwritenonatomiccopyinherited |
Constant value or an expression that specifies the angle of rotation based on a feature's attribute value. When an attribute name is specified in rotationExpression, it's enclosed in square brackets, for example, [Rotation].
- Since
- 100
◆ rotationType
|
readwritenonatomicassigninherited |
Controls the origin and direction of rotation. If the rotationType is defined as AGSRotationTypeTypeArithmetic, the symbol is rotated from East in a counter-clockwise direction where East is the 0° axis. If the rotationType is defined as AGSRotationTypeGeographic, the symbol is rotated from North in a clockwise direction where North is the 0° axis.
- Since
- 100
◆ sceneProperties
|
readwritenonatomicstronginherited |
Properties to apply only when rendering data in 3D scenes using AGSSceneView.
- Since
- 100
◆ unknownJSON
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
- Returns
NSDictionarycontaining the unknown JSON.
- Since
- 100
◆ unsupportedJSON
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
- Returns
NSDictionarycontaining the unsupported JSON.
- Since
- 100
