SubtypeSublayer

AMD: require(["esri/layers/support/SubtypeSublayer"], (SubtypeSublayer) => { /* code goes here */ });
ESM: import SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer";
Class: esri/layers/support/SubtypeSublayer
Since: ArcGIS API for JavaScript 4.20

Represents a sublayer in a SubtypeGroupLayer. Each SubtypeSublayer is not a standalone service, but rather each sublayer corresponds to one subtype in the source feature service. This pattern allows each sublayer to be symbolized independently of one another, without requiring an individual service per sublayer. This relationship differs from the relationship between the MapImageLayer and its sublayers. In the case with the MapImageLayer, its sublayers represent individual map services.

The SubtypeSublayers are identified by their unique subtypeCode. You can configure the properties of each sublayer while initializing the SubtypeGroupLayer

See also
Example
// Only includes one SubtypeSublayer from the SubtypeGroupLayer
let layer = new SuptypeGroupLayer({
  url: "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleElectric/FeatureServer/0",
  sublayers: [{  // autocasts as a Collection of SubtypeSublayers
    subtypeCode: 14,
    visible: true,
    renderer: {
      type: "simple",  // autocasts as a SimpleRenderer()
      symbol: {
        type: "simple-marker",  // autocasts as a SimpleMarkerSymbol()
        style: "circle",
        color: [120, 120, 120, 255],
        size: 6
      }
    }
  }]
});

Constructors

new SubtypeSublayer(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Name Type Summary Class
Boolean

Determines if the layer is editable.

more details
SubtypeSublayer
Field[]

An array of fields in the layer.

more details
SubtypeSublayer
FormTemplate

The template used in an associated layer's FeatureForm.

more details
SubtypeSublayer
LabelClass[]

The label definition for this layer, specified as an array of LabelClass.

more details
SubtypeSublayer
Boolean

Indicates whether to display labels for this layer.

more details
SubtypeSublayer
Boolean

Indicates whether the layer will be included in the legend.

more details
SubtypeSublayer
Number

The maximum scale (most zoomed in) at which the layer is visible in the view.

more details
SubtypeSublayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

more details
SubtypeSublayer
Number

The opacity of the layer.

more details
SubtypeSublayer
Boolean

Indicates whether to display popups when features in the layer are clicked.

more details
SubtypeSublayer
PopupTemplate

The popup template for the layer.

more details
SubtypeSublayer
Renderer

The renderer assigned to the layer.

more details
SubtypeSublayer
Number

The unique identifier representing the SubtypeSublayer created from the SubtypeGroupLayer.

more details
SubtypeSublayer
FeatureTemplate[]

An array of feature templates defined in the feature layer.

more details
SubtypeSublayer
String

The title of the layer used to identify it in places such as the Legend widget.

more details
SubtypeSublayer
String For SubtypeSublayer the type is always "subtype-sublayer". more detailsSubtypeSublayer
Boolean

Indicates if the layer is visible in the View.

more details
SubtypeSublayer

Property Details

editingEnabled Boolean

Determines if the layer is editable.

Default Value:true
See also
fields Field[]readonly

An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer. For example, a field named POP_2015, stores information about total population as a numeric value for each feature; this value represents the total number of people living within the geographic bounds of the feature.

Example
// define each field's schema
const fields = [
 new Field({
   name: "ObjectID",
   alias: "ObjectID",
   type: "oid"
 }), new Field({
   name: "description",
   alias: "Description",
   type: "string"
 }), new Field ({
   name: "title",
   alias: "Title",
   type: "string"
 })
];

// See the sample snippet for the source property
const layer = new SubtypeSublayer({
  // Object ID field is inferred from the fields array
  fields: fields
});
formTemplate FormTemplateautocast

The template used in an associated layer's FeatureForm. All of the properties and field configurations set on the layer's FeatureForm are handled via the FormTemplate.

See also
Example
// Create the Field Elements to pass into the template
const fieldElement1 = new FieldElement({
  fieldName: "firstname",
  label: "First name",
  description: "First name of emergency contact"
});

const fieldElement2 = new FieldElement({
  fieldName: "lastname",
  label: "Last name",
  description: "Last name of emergency contact"
});

// Create the form's template
const formTemplate = new FormTemplate({
  title: "Emergency information",
  description: "In case of emergency, update any additional information needed",
  elements: [fieldElement1, fieldElement2] // pass in array of field elements from above
});

// Pass the template to the layer
subtypeSublayer.formTemplate = formTemplate;

// Pass the layer to the FeatureForm
const form = new FeatureForm({
  container: "form", // html div referencing the form
  layer: subtypeSublayer
});
labelingInfo LabelClass[]autocast
Autocasts from Object[]

The label definition for this layer, specified as an array of LabelClass. Use this property to specify labeling properties for the layer such as label expression, placement, and size.

Multiple Label classes with different where clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks).

See the Labeling guide page for more information and known limitations.

Known Limitations

3D SceneViews only support displaying one LabelClass per feature.

See also
Example
const statesLabelClass = new LabelClass({
  labelExpressionInfo: { expression: "$feature.NAME" },
  symbol: {
    type: "text",  // autocasts as new TextSymbol()
    color: "black",
    haloSize: 1,
    haloColor: "white"
  }
});

subtypeSubLayer.labelingInfo = [ statesLabelClass ];
labelsVisible Boolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

Known Limitations

3D SceneViews only support displaying one LabelClass per feature.

Default Value:true
legendEnabled Boolean

Indicates whether the layer will be included in the legend.

Default Value:true
maxScale Number

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default Value:0
minScale Number

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0
opacity Number

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1
Example
// Makes the layer 50% transparent
layer.opacity = 0.5;
popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.

Default Value:true
See also
popupTemplate PopupTemplateautocast

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values in the view's popup when a feature is selected using text and/or charts. See the PopupTemplate sample for an example of how PopupTemplate interacts with a FeatureLayer.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

See also
renderer Rendererautocast

The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions.

However, when creating a FeatureLayer from client-side features, this property must be specified in the layer's constructor along with the source, fields, objectIdField properties.

Example
// all features in the layer will be visualized with
// a 6pt black marker symbol and a thin, white outline
layer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    size: 6,
    color: "black",
    outline: {  // autocasts as new SimpleLineSymbol()
      width: 0.5,
      color: "white"
    }
  }
};
subtypeCode Number

The unique identifier representing the SubtypeSublayer created from the SubtypeGroupLayer.

Default Value:null
templates FeatureTemplate[]

An array of feature templates defined in the feature layer. See ArcGIS Pro subtypes document.

title String

The title of the layer used to identify it in places such as the Legend widget. The title is set to the subtype description of layer.

type Stringreadonly

For SubtypeSublayer the type is always "subtype-sublayer".

visible Boolean

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value:true
Example
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

Name Return Type Summary Class
PopupTemplate

Creates a popup template for the layer, populated with all the fields of the layer.

more details
SubtypeSublayer
Field

Returns the Field instance for a field name (case-insensitive).

more details
SubtypeSublayer
Domain

Returns the Domain associated with the given field name.

more details
SubtypeSublayer

Method Details

createPopupTemplate(options){PopupTemplate}

Creates a popup template for the layer, populated with all the fields of the layer.

Parameter
optional

Options for creating the popup template.

Returns
Type Description
PopupTemplate The popup template, or null if the layer does not have any fields.
getField(fieldName){Field}

Returns the Field instance for a field name (case-insensitive).

Parameter
fieldName String

Name of the field.

Returns
Type Description
Field the matching field or undefined
See also
getFieldDomain(fieldName){Domain}

Returns the Domain associated with the given field name. The domain can be either a CodedValueDomain or RangeDomain.

Parameter
fieldName String

Name of the field.

Returns
Type Description
Domain The Domain object associated with the given field name for the given feature.
Example
// Get a range domain associated with the first feature
// returned from queryFeatures().
subtypeSublayer.queryFeatures(query).then(function(results){
  const domain = subtypeSublayer.getFieldDomain("Height");
  console.log("domain", domain)
});

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