A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html below:

Portal | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import Portal from "@arcgis/core/portal/Portal.js";

CDN: const Portal = await $arcgis.import("@arcgis/core/portal/Portal.js");

Class: @arcgis/core/portal/Portal

Since: ArcGIS Maps SDK for JavaScript 4.0

The Portal class is part of the ArcGIS Enterprise portal that provides a way to build applications that work with content from ArcGIS Online or an ArcGIS Enterprise portal. ArcGIS Enterprise is software from Esri that customers can deploy either on-premises or in the cloud. ArcGIS Online is Esri's Software as a Service offering that represents GIS as a Service and is implemented using the same technology as ArcGIS Enterprise.

The Portal API allows application developers to work with users, groups and content hosted within ArcGIS Online or within an ArcGIS Enterprise portal. The API allows developers to build web, mobile, and desktop applications that support sharing and collaboration using web maps. Organizational developers can also use the API to build custom applications for their users.

The Portal class provides a view of the portal as seen by the current user, anonymous or logged in. It includes information such as the name, logo, featured items and supported protocols (http vs https) for this portal. If the user is not logged in, this call will return the default view of the portal. If the user is logged in, the view of the portal returned will be specific to the organization that the user belongs to. The default view of the portal is dependent on the culture of the user that is obtained from the users profile.

If no url is set before loading the Portal, the API defaults to that of esriConfig.portalUrl. There may be scenarios when more than one portal instance are needed. In these circumstances, there are a couple of different options to take into account.

  1. Set a new Portal instance within the PortalItem and set the portal's url.
    Layer.fromPortalItem({
      portalItem: {
        id: "e691172598f04ea8881cd2a4adaa45ba",
        // autocastable to Portal
        portal: {
          url: "https://thePortalUrl"
        }
      }
    });
    
  2. Create separate portal instances before passing them into the PortalItem's portal property.
    let portalA = new Portal({
      url: "https://www.exampleA.com/arcgis" // First instance
    });
    
    let portalB = new Portal({
      url: "https://www.exampleB.com/arcgis" // Second instance
    });
    
    let item = new PortalItem({
      id: "e691172598f04ea8881cd2a4adaa45ba",
      portal: portalA // This loads the first portal instance set above
    });
    
    item.load();
    

The when() method on the Portal instance can be called to execute processes that may only run after the Portal is loaded.

// load the Portal and PortalQueryParams modules
const [Portal, PortalQueryParams] = await $arcgis.import([
  "@arcgis/core/portal/Portal.js",
  "@arcgis/core/portal/PortalQueryParams.js"
]);
portal = new Portal();
// Setting authMode to immediate signs the user in once loaded
portal.authMode = "immediate";

// Once portal is loaded, user signed in
portal.load().then(function() {
  console.log(portal);

  // Create query parameters for the portal search
  // This object autocasts as new PortalQueryParams()
  let queryParams = {
    query: "owner:" + portal.user.username,
    sortField: "numViews",
    sortOrder: "desc",
    num: 20
  };
  // Query the items based on the queryParams created from portal above
  portal.queryItems(queryParams).then(createGallery);
});
See also
Constructors
Portal Constructor new Portal(properties)

Parameter

optional

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

Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties Hide inherited properties

Name Type Summary Class access String|null|undefined

The access level of the organization.

Portal allSSL Boolean

When true, access to the organization's Portal resources must occur over SSL.

Portal authMode String

The authentication mode for handling authentication when the user attempts to access a secure resource.

Portal authorizedCrossOriginDomains String[]|null|undefined

Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication.

Portal basemapGalleryGroupQuery String|null|undefined

The query that defines the basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is not true.

Portal basemapGalleryGroupQuery3D String|null|undefined

The query that defines the 3D basemaps that should be displayed in the BasemapGallery.

Portal bingKey String|null|undefined

The Bing key to use for web maps using Bing Maps.

Portal canListApps Boolean

Indicates whether an organization can list applications in the marketplace.

Portal canListData Boolean

Indicates whether an organization can list data services in the marketplace.

Portal canListPreProvisionedItems Boolean

Indicates whether an organization can list pre-provisioned items in the marketplace.

Portal canProvisionDirectPurchase Boolean

Indicates whether an organization can provision direct purchases in the marketplace without customer request.

Portal canSearchPublic Boolean

When true, the organization's public items, groups and users are included in search queries.

Portal canShareBingPublic Boolean

The Bing key can be shared to the public and is returned as part of a portal's description call (/sharing/rest/portals/<orgid>).

Portal canSharePublic Boolean

When true, members of the organization can share resources outside the organization.

Portal canSignInArcGIS Boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in.

Portal canSignInIDP Boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in.

Portal colorSetsGroupQuery String|null|undefined

The query that identifies the group containing the color sets used for rendering in the map viewer.

Portal commentsEnabled Boolean

Indicates whether to allow the organization to disable commenting.

Portal created Date|null|undefined

Date the organization was created.

Portal culture String|null|undefined

The default locale (language and country) information.

Portal customBaseUrl String|null|undefined

The custom base URL for the portal.

Portal declaredClass String

The name of the class.

Accessor default3DBasemapQuery String|null|undefined

The query that defines the default 3d basemap to use in scene views for the portal.

Portal defaultBasemap Basemap|null|undefined

The default basemap to use for the portal.

Portal defaultDevBasemap Basemap|null|undefined

The default developer basemap to use for the portal when an apiKey is defined.

Portal defaultExtent Extent|null|undefined

The default extent to use for the portal.

Portal defaultVectorBasemap Basemap|null|undefined

The default vector basemap to use for the portal.

Portal description String|null|undefined

A description of the organization/portal.

Portal devBasemapGalleryGroupQuery String|null|undefined

The query that defines the basemaps that should be displayed in the BasemapGallery when an apiKey is defined.

Portal eueiEnabled Boolean|null|undefined

Boolean value indicating whether to opt-in to the Esri User Experience Improvement (EUEI) program.

Portal featuredGroups Object[]|null|undefined

The featured groups for the portal.

Portal featuredItemsGroupQuery String|null|undefined

The query that defines the featured group.

Portal galleryTemplatesGroupQuery String|null|undefined

The query that identifies the group containing features items for the gallery.

Portal hasCategorySchema Boolean

Indicates whether the organization has content categories.

Portal hasClassificationSchema Boolean

Indicates whether the organization has classification schema.

Portal helperServices Object|null|undefined

This class contains properties to obtain information for various web services available on the portal.

Portal homePageFeaturedContent String|null|undefined

The group that contains featured content to be displayed on the home page.

Portal homePageFeaturedContentCount Number|null|undefined

The number of featured items that can be displayed on the home page.

Portal httpPort Number|null|undefined

The port used by the portal for HTTP communication.

Portal httpsPort Number|null|undefined

The port used by the portal for HTTPS communication.

Portal id String|null|undefined

The id of the organization that owns this portal.

Portal ipCntryCode String|null|undefined

The country code of the calling IP (ArcGIS Online only).

Portal isOrganization Boolean

Indicates whether the portal is an organization.

Portal isPortal Boolean

Indicates if the portal is on-premises.

Portal isReadOnly Boolean

Indicates if the portal is in read-only mode.

Portal layerTemplatesGroupQuery String|null|undefined

The query that identifies the group containing editing templates.

Portal loadError Error|null|undefined

The Error object returned if an error occurred while loading.

Portal loadStatus String

Represents the status of a load operation.

Portal loadWarnings Object[]

A list of warnings which occurred while loading.

Portal loaded Boolean

Indicates whether the portal's resources have loaded.

Portal maxTokenExpirationMinutes Number|null|undefined

The maximum validity in minutes of tokens issued for users of the organization.

Portal modified Date|null|undefined

Date the organization was last modified.

Portal name String|null|undefined

Name of the organization.

Portal portalHostname String|null|undefined

URL of the portal host.

Portal portalMode String|null|undefined

The portal mode.

Portal portalProperties Object

Properties specific to the organization, for example the "contact us" link.

Portal recycleBinEnabled Boolean

Indicates whether the recycle bin is enabled for the organization.

Portal region String|null|undefined

The region for the organization.

Portal restUrl String

The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online and "https://www.example.com/arcgis/sharing/rest" for your in-house portal.

Portal rotatorPanels Object[]|null|undefined

Custom HTML for the home page.

Portal showHomePageDescription Boolean

Indicates whether the description of your organization displays on the home page.

Portal sourceJSON Object

The JSON used to create the property values when the Portal is loaded.

Portal supportsHostedServices Boolean

Indicates whether hosted services are supported.

Portal symbolSetsGroupQuery String|null|undefined

The query that defines the symbols sets.

Portal templatesGroupQuery String|null|undefined

The query that defines the collection of templates that will appear in the template gallery.

Portal thumbnailUrl String|null|undefined

The URL to the thumbnail of the organization.

Portal units String|null|undefined

Sets the units of measure for the organization's users.

Portal url String

The URL to the portal instance.

Portal urlKey String|null|undefined

The prefix selected by the organization's administrator to be used with the customBaseURL.

Portal use3dBasemaps Boolean

When false, 3D basemaps are hidden from the BasemapGallery, regardless of the type of the view.

Portal useDefault3dBasemap Boolean

When false, The default 3d basemap is not used in the SceneViewer.

Portal useStandardizedQuery Boolean

When true, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables.

Portal useVectorBasemaps Boolean

When true, the organization has opted in to use the vector tile basemaps, and (a) vectorBasemapGalleryGroupQuery should be used instead of basemapGalleryGroupQuery, while (b) defaultVectorBasemap should be used instead of defaultBasemap.

Portal user PortalUser|null|undefined

Information representing a registered user of the portal.

Portal vectorBasemapGalleryGroupQuery String|null|undefined

The query that defines the vector tiles basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is true.

Portal Property Details

The access level of the organization. When public, anonymous users can access the organization. When private, access is restricted to only members of the organization.

Possible Values:"public" |"private"

When true, access to the organization's Portal resources must occur over SSL.

authMode Property authMode String

The authentication mode for handling authentication when the user attempts to access a secure resource.

Possible Value Description anonymous An error will be returned when a secure resource is requested. auto The user will be signed in when a secure resource is requested. immediate The user will be signed in when the Portal is loaded. no-prompt Checks for whether the user is already signed in. If so, no additional prompts display for sign-in.

Possible Values:"anonymous" |"auto" |"immediate" |"no-prompt"

Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication.

Since: ArcGIS Maps SDK for JavaScript 4.4 Portal since 4.0, basemapGalleryGroupQuery added at 4.4.

The query that defines the basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is not true. The fetchBasemaps() method does this automatically.

Since: ArcGIS Maps SDK for JavaScript 4.27 Portal since 4.0, basemapGalleryGroupQuery3D added at 4.27.

The query that defines the 3D basemaps that should be displayed in the BasemapGallery. The fetchBasemaps() method does this automatically.

The Bing key to use for web maps using Bing Maps.

canListApps Property canListApps Boolean

Indicates whether an organization can list applications in the marketplace.

canListData Property canListData Boolean

Indicates whether an organization can list data services in the marketplace.

canListPreProvisionedItems Property canListPreProvisionedItems Boolean

Indicates whether an organization can list pre-provisioned items in the marketplace.

canProvisionDirectPurchase Property canProvisionDirectPurchase Boolean

Indicates whether an organization can provision direct purchases in the marketplace without customer request.

canSearchPublic Property canSearchPublic Boolean

When true, the organization's public items, groups and users are included in search queries. When false, no public items outside of the organization are included. However, public items which are part of the organization are included.

canShareBingPublic Property canShareBingPublic Boolean

The Bing key can be shared to the public and is returned as part of a portal's description call (/sharing/rest/portals/<orgid>). This requires the access of the portal to be set to public. The canShareBingPublic property is not returned publicly but only shown to users within the organization.

canSharePublic Property canSharePublic Boolean

When true, members of the organization can share resources outside the organization.

canSignInArcGIS Property canSignInArcGIS Boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in.

canSignInIDP Property canSignInIDP Boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in.

The query that identifies the group containing the color sets used for rendering in the map viewer.

commentsEnabled Property commentsEnabled Boolean

Indicates whether to allow the organization to disable commenting. When commentsEnabled is false, comments are hidden and not removed. numComments are set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization re-enables comments, the comments display and numComments are restored.

Date the organization was created.

The default locale (language and country) information.

The custom base URL for the portal.

declaredClass

Inherited

Property declaredClass Stringreadonly

Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

Since: ArcGIS Maps SDK for JavaScript 4.31 Portal since 4.0, default3DBasemapQuery added at 4.31.

The query that defines the default 3d basemap to use in scene views for the portal. The fetchDefault3DBasemap() method uses this to return a basemap object.

The default basemap to use for the portal. Used in the map viewer.

Since: ArcGIS Maps SDK for JavaScript 4.22 Portal since 4.0, defaultDevBasemap added at 4.22.

The default developer basemap to use for the portal when an apiKey is defined.

The default extent to use for the portal. Used in the map viewer. The extent will be in the default basemap's spatial reference.

Since: ArcGIS Maps SDK for JavaScript 4.4 Portal since 4.0, defaultVectorBasemap added at 4.4.

The default vector basemap to use for the portal. Used in the map viewer.

A description of the organization/portal.

Since: ArcGIS Maps SDK for JavaScript 4.22 Portal since 4.0, devBasemapGalleryGroupQuery added at 4.22.

The query that defines the basemaps that should be displayed in the BasemapGallery when an apiKey is defined. The fetchBasemaps() method does this automatically.

The featured groups for the portal. Returns an array of objects that provide access to the owner and title for each featured group. Each item in this array has the following specification:

Properties

Name of the group owner.

Group title.

The query that defines the featured group. If null, then the most viewed items in the organization will be the featured items.

The query that identifies the group containing features items for the gallery. Set a Group ID or, if null, then the most viewed items in your organization are displayed in the gallery.

hasCategorySchema Property hasCategorySchema Boolean

Since: ArcGIS Maps SDK for JavaScript 4.8 Portal since 4.0, hasCategorySchema added at 4.8.

Indicates whether the organization has content categories.

hasClassificationSchema Property hasClassificationSchema Boolean

Since: ArcGIS Maps SDK for JavaScript 4.31 Portal since 4.0, hasClassificationSchema added at 4.31.

Indicates whether the organization has classification schema.

Since: ArcGIS Maps SDK for JavaScript 4.4 Portal since 4.0, helperServices added at 4.4.

This class contains properties to obtain information for various web services available on the portal. This is useful for determining the URLs for relevant methods from the portal.helperServices object. The url property of each helper service is the URL to the REST endpoint for that service.

It is recommended to use these URLs with their respective rest modules instead of the deprecated helper methods. For additional information about helper services, see the about utility services topic from the ArcGIS Server documentation.

Example

// create new Portal object with relevant URL
const portal = new Portal({
  url: "YOUR_PORTAL_URL"
});

// load Portal instance
portal.load().then(function() {
  // display all helper services
  console.log("Show available helperServices: ", portal.helperServices);
  // access helperServices from the Portal instance
  // to get the routing URL of interest
  const routeURL = portal.helperServices.route.url;
  // use helperServices to perform routing
  route.solve(routeURL, routeParams).then(showRouteInfo);
}

The group that contains featured content to be displayed on the home page.

The number of featured items that can be displayed on the home page. The max is 100. Accepts integers only.

The port used by the portal for HTTP communication.

The port used by the portal for HTTPS communication.

The id of the organization that owns this portal. If null then this is the default portal for anonymous and non-organizational users.

The country code of the calling IP (ArcGIS Online only).

isOrganization Property isOrganization Booleanreadonly

Indicates whether the portal is an organization.

Indicates if the portal is on-premises.

isReadOnly Property isReadOnly Boolean

Since: ArcGIS Maps SDK for JavaScript 4.14 Portal since 4.0, isReadOnly added at 4.14.

Indicates if the portal is in read-only mode. When true, content cannot be created, modified, or deleted on the Portal.

The query that identifies the group containing editing templates.

The Error object returned if an error occurred while loading.

loadStatus Property loadStatus Stringreadonly

Represents the status of a load operation.

Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded" |"loading" |"failed" |"loaded"

Default Value:"not-loaded"

loadWarnings Property loadWarnings Object[]readonly

A list of warnings which occurred while loading.

loaded Property loaded Booleanreadonly

Indicates whether the portal's resources have loaded. When true, all the properties of the object can be accessed.

The maximum validity in minutes of tokens issued for users of the organization. -1 is the default and is a special value that indicates infinite timeout or permanent tokens. For tokens granted using OAuth 2.0 authorization grant, it represents the maximum validity of refresh tokens. For access tokens, the maximum validity is the lower of two weeks or this value.

Date the organization was last modified.

Name of the organization.

The portal mode.

Possible Values:"multitenant" |"singletenant"

portalProperties Property portalProperties Object

Properties specific to the organization, for example the "contact us" link. If the organization is public, the properties are visible to the anonymous user.

recycleBinEnabled Property recycleBinEnabled Boolean

Since: ArcGIS Maps SDK for JavaScript 4.30 Portal since 4.0, recycleBinEnabled added at 4.30.

Indicates whether the recycle bin is enabled for the organization.

The region for the organization.

Custom HTML for the home page.

showHomePageDescription Property showHomePageDescription Boolean

Indicates whether the description of your organization displays on the home page.

sourceJSON Property sourceJSON Object

Since: ArcGIS Maps SDK for JavaScript 4.13 Portal since 4.0, sourceJSON added at 4.13.

The JSON used to create the property values when the Portal is loaded. Although most commonly used properties are exposed on the Portal class directly, this provides access to all information returned by the portal. This property is useful if working in an application built using an older version of the API which requires access to portal properties from a more recent version.

supportsHostedServices Property supportsHostedServices Boolean

Indicates whether hosted services are supported.

The query that defines the symbols sets.

The query that defines the collection of templates that will appear in the template gallery.

The URL to the thumbnail of the organization.

Sets the units of measure for the organization's users. The user default is derived from the organization's region.

Possible Values:"english" |"metric"

The URL to the portal instance. Setting the location of the portal instance via esriConfig.portalUrl should be used in favor of setting it directly on this property.

If using an on-premise portal, the syntax should look similar to: https://www.example.com/arcgis

Default Value: The default value for this property is the same as the esriConfig.portalUrl property value.

The prefix selected by the organization's administrator to be used with the customBaseURL.

use3dBasemaps Property use3dBasemaps Boolean

Since: ArcGIS Maps SDK for JavaScript 4.27 Portal since 4.0, use3dBasemaps added at 4.27.

When false, 3D basemaps are hidden from the BasemapGallery, regardless of the type of the view.

useDefault3dBasemap Property useDefault3dBasemap Boolean

Since: ArcGIS Maps SDK for JavaScript 4.31 Portal since 4.0, useDefault3dBasemap added at 4.31.

When false, The default 3d basemap is not used in the SceneViewer.

useStandardizedQuery Property useStandardizedQuery Boolean

When true, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. The recommended security setting is true.

Information representing a registered user of the portal.

Since: ArcGIS Maps SDK for JavaScript 4.4 Portal since 4.0, vectorBasemapGalleryGroupQuery added at 4.4.

The query that defines the vector tiles basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is true. The fetchBasemaps() method does this automatically.

Method Overview

Show inherited methods Hide inherited methods

Method Details
addHandles

Inherited

Method addHandles(handleOrHandles, groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancelLoad Method cancelLoad()

Cancels a load() operation if it is already in progress.

fetchBasemaps Method fetchBasemaps(basemapGalleryGroupQuery, options){Promise<Basemap[]>}

Fetches the basemaps that are displayed in the BasemapGallery. When an apiKey is defined, the basemaps will be based on devBasemapGalleryGroupQuery. When useVectorBasemaps is true, the basemaps will be based on vectorBasemapGalleryGroupQuery. Otherwise, it is based on basemapGalleryGroupQuery.

Parameters

Specification

basemapGalleryGroupQuery String optional

When provided, this argument is used to fetch basemaps based on input query parameters.

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

optional

When true the basemaps based on basemapGalleryGroupQuery3D are also fetched, if no basemapGalleryGroupQuery is passed as an argument. When true and a custom basemapGalleryGroupQuery is passed, also 3D basemaps from the custom group are fetched. When not specified, it will default to use3dBasemaps.

Returns

Type Description Promise<Basemap[]> Resolves to an array of Basemap objects representing the basemaps used in the Basemap Gallery of the Portal.

Example

portal.fetchBasemaps("title:\"Cloud Creek Basemaps\" AND owner:jsmith")
 .then(function(basemaps){
   // do something with the basemaps
 });
fetchCategorySchema Method fetchCategorySchema(options){Promise<Object[]>}

Since: ArcGIS Maps SDK for JavaScript 4.8 Portal since 4.0, fetchCategorySchema added at 4.8.

If present, fetches the organization's category schema.

Parameters

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type Description Promise<Object[]> Resolves to an array of objects containing the following properties: Property Type Description title string The title of the category schema. categories object[] An array of objects containing a title and an array of categories.

Example

// Fetches the category schema
portal.fetchCategorySchema().then(function(schemas){
  schemas.forEach(function(schema){
    console.log("schema: ", schema);
  });
});
fetchClassificationSchema Method fetchClassificationSchema(options){Promise<(Object|null|undefined)>}

Since: ArcGIS Maps SDK for JavaScript 4.32 Portal since 4.0, fetchClassificationSchema added at 4.32.

If present, fetches the organization's classification schema.

Parameters

optional

An object.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Example

// Fetches the classification schema
portal.fetchClassificationSchema().then(function(schema){
  console.log("schema: ", schema);
});

Since: ArcGIS Maps SDK for JavaScript 4.31 Portal since 4.0, fetchDefault3DBasemap added at 4.31.

Fetches the default 3d Basemap to use in SceneView for this portal.

Parameters

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

fetchFeaturedGroups Method fetchFeaturedGroups(options){Promise<PortalGroup[]>}

Fetches the featured groups in the Portal.

Parameters

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Example

// fetch featured groups
portal.fetchFeaturedGroups().then(function(groups){
   groups.forEach(function(group){
     group.fetchMembers().then(function(members){
       console.log("member", members);
     });
   });
});
fetchRegions Method fetchRegions(options){Promise<Object[]>}

Since: ArcGIS Maps SDK for JavaScript 4.8 Portal since 4.0, fetchRegions added at 4.8.

Fetches and returns the associated regions with the portal instance.

Parameters

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type Description Promise<Object[]> Resolves to an array of objects containing the following properties: Property Type Description localizedName string The localized name for the region. For example, "Australia". name string The name of the region. For example, "Australia". region string Region name. For example, "AU".
fetchSettings Method fetchSettings(options){Promise<Object>}

Since: ArcGIS Maps SDK for JavaScript 4.23 Portal since 4.0, fetchSettings added at 4.23.

Fetches and returns the portal settings as seen by the current user(s), whether anonymous or signed in. This returns information such as any accessible helper services, allowed redirect URIs, and the configuration for any access notices or information banners.

Parameters

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type Description Promise<Object> Resolves to an object containing information such as helper services, redirect URIs, and configurations for access notices or information banners.
getDefault Method getDefault(){Portal}static

A new Portal instance is created the first time this method is called. The URL from config.portalUrl is automatically used for this instance. This instance is then cached and used for any subsequent calls to this method.

Returns

Type Description Portal The Portal instance.
hasHandles

Inherited

Method hasHandles(groupKey){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type Description Boolean Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
isFulfilled Method isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected Method isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been rejected.
isResolved Method isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been resolved.
load Method load(options){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameters

optional

Additional options.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type Description Promise Resolves when the resources have loaded.

Executes a query against the Portal to return an array of PortalGroup objects that match the input query.

Parameters

The input query parameters defined in PortalQueryParams.

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Executes a query against the Portal to return an array of PortalItem objects that match the input query.

Parameters

The input query parameters defined in PortalQueryParams.

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Example

// Once portal is loaded, user signed in
  portal.load().then(function() {
    console.log(portal);

    // Create query parameters for the portal search
    // This object autocasts as new PortalQueryParams()
    let queryParams = {
      query: "owner:" + portal.user.username,
      sortField: "numViews",
      sortOrder: "desc",
      num: 20
    };

    // Query the items based on the queryParams created from portal above
    portal.queryItems(queryParams).then(createGallery);
  });

Executes a query against the Portal to return an array of PortalUser objects that match the input query.

Parameters

The input query parameters defined in PortalQueryParams.

optional

An object with the following properties.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Example

// Once portal is loaded, user signed in
portal.load().then(function() {
   // queryUsers
   // This object autocasts as new PortalQueryParams()
   let queryParameters = {
     query: "username:" + portal.user.username
   };

   portal.queryUsers(queryParameters).then(function(queryResults){
     queryResults.results[0].fetchFolders().then(function(folders){
       folders.forEach(function(folder){
         console.log(" user folder", folder.title);
       });
     });
   });
});
removeHandles

Inherited

Method removeHandles(groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
when Method when(callback, errback){Promise}

Since: ArcGIS Maps SDK for JavaScript 4.6 Portal since 4.0, when added at 4.6.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type Description Promise Returns a new promise for the result of callback that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4