diff --git a/guide/03-the-gis/customizing-the-look-and-feel-of-your-gis.ipynb b/guide/03-the-gis/customizing-the-look-and-feel-of-your-gis.ipynb index 50d8f9553f..dd4de84d65 100644 --- a/guide/03-the-gis/customizing-the-look-and-feel-of-your-gis.ipynb +++ b/guide/03-the-gis/customizing-the-look-and-feel-of-your-gis.ipynb @@ -1 +1,457 @@ -{"cells": [{"cell_type": "markdown", "metadata": {}, "source": ["# Customizing the look and feel of your GIS\n", "\n", "As an administrator of your GIS, you can configure the appearance of the portal website to make it home for your users. The `UX` class of the `admin` sub module can be used to customize the look and feel of your portal website by setting the name, description, logo, background image, banner image, default basemap, extent etc.\n", "\n", "You can use the `UX` class on organizations hosted on ArcGIS Online or ArcGIS Enterprise. To note here, the GIS connection can be created by using username/password, e.g. `gis = GIS(\"portalname.domain.com/webadaptor\", \"username\", \"password\")`, or through an existing profile."]}, {"cell_type": "markdown", "metadata": {"toc": true}, "source": ["

Table of Contents

\n", "
"]}, {"cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [], "source": ["from arcgis.gis import GIS\n", "gis = GIS(profile=\"your_ent_admin_profile\")"]}, {"cell_type": "markdown", "metadata": {}, "source": ["When you install ArcGIS Enterprise or create a new organization on ArcGIS Online, it would look similar to the image shown below:"]}, {"cell_type": "markdown", "metadata": {}, "source": [""]}, {"cell_type": "markdown", "metadata": {}, "source": ["The rest of this guide walks you through customizing this GIS. As an example, this guide chooses to customize this GIS for Public Works Department of the city of Los Angeles."]}, {"cell_type": "markdown", "metadata": {}, "source": ["## Setting name and description\n", "Use the `name` and `description` to both query and set them on the GIS."]}, {"cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [{"data": {"text/plain": ["'ArcGIS Enterprise'"]}, "execution_count": 2, "metadata": {}, "output_type": "execute_result"}], "source": ["gis.admin.ux.name"]}, {"cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [{"data": {"text/plain": ["'
'"]}, "execution_count": 3, "metadata": {}, "output_type": "execute_result"}], "source": ["gis.admin.ux.description"]}, {"cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [{"data": {"text/plain": ["False"]}, "execution_count": 4, "metadata": {}, "output_type": "execute_result"}], "source": ["gis.admin.ux.description_visibility"]}, {"cell_type": "markdown", "metadata": {}, "source": ["To set new name and description, simply set these properties"]}, {"cell_type": "code", "execution_count": 5, "metadata": {"collapsed": true}, "outputs": [], "source": ["gis.admin.ux.name = 'LA PWD GIS'\n", "gis.admin.ux.description = 'Spatial information portal for the Public Works Department of the city of Los Angeles'\n", "gis.admin.ux.description_visibility = True"]}, {"cell_type": "markdown", "metadata": {}, "source": ["Once the name and description is set, the portal website looks like below:\n", "\n", "\n", "
Note: The name of the GIS shows up in the browser tab name. Description shows up in the gray bar. To update the large 'ArcGIS Enterprise' text, you need to update the banner image as shown below:
"]}, {"cell_type": "markdown", "metadata": {}, "source": ["## Setting logo, banner and background images\n", "To set the logo, banner and background images, call the `set_logo()`, `set_banner()` and `set_background()` methods. Your GIS might come with a set of built-in images. You can use one of those or upload your own. If using a built-in banner, valid values are `banner-1`, `banner-2`, `banner-3`, `banner-4`, `banner-5` and set the `is_built_in` to `True`. The example below uploads a custom banner and background file from disk."]}, {"cell_type": "markdown", "metadata": {}, "source": ["Python 3.4 introduced a new standard library for dealing with files and paths called `pathlib`\u200a\u2014\u200aand it\u2019s making things simpler in representing directories and files via absolute or relative paths across different operating systems."]}, {"cell_type": "code", "execution_count": 6, "metadata": {}, "outputs": [{"data": {"text/plain": ["True"]}, "execution_count": 6, "metadata": {}, "output_type": "execute_result"}], "source": ["from pathlib import Path\n", "\n", "filename = Path('staticimg/background.jpg')\n", "if filename.exists():\n", " print(gis.admin.ux.set_background(background_file=filename))\n", "else:\n", " print(\"file not exists!\")"]}, {"cell_type": "code", "execution_count": 7, "metadata": {}, "outputs": [{"data": {"text/plain": ["True"]}, "execution_count": 7, "metadata": {}, "output_type": "execute_result"}], "source": ["filename = Path('staticimg/banner.png')\n", "if filename.exists():\n", " print(gis.admin.ux.set_banner(banner_file=filename))\n", "else:\n", " print(\"file not exists!\")"]}, {"cell_type": "code", "execution_count": 8, "metadata": {}, "outputs": [{"data": {"text/plain": ["True"]}, "execution_count": 8, "metadata": {}, "output_type": "execute_result"}], "source": ["filename = Path('staticimg/logo.png')\n", "if filename.exists():\n", " print(gis.admin.ux.set_logo(logo_file=filename))\n", "else:\n", " print(\"file not exists!\")"]}, {"cell_type": "markdown", "metadata": {}, "source": ["Refershing the portal website will render the new appearance:\n", "\n", "\n", "
Note: Refer the help on configuring home page to understand the dimensions of the images for best appearance. You can also pass custom HTML code while setting the banner. To learn more about that refer here.
\n", "\n", "### Download existing customizations\n", "You can download the current banner, logo, background values using the corresponding `get` methods"]}, {"cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [{"name": "stdout", "output_type": "stream", "text": ["staticimg\\downloads\\banner.jpg\n"]}], "source": ["dirname = Path('staticimg/downloads')\n", "if dirname.exists():\n", " print(gis.admin.ux.get_banner(download_path = dirname))\n", "else:\n", " print(\"downloading folder not exists!\")"]}, {"cell_type": "markdown", "metadata": {}, "source": ["### Resetting customization\n", "You can reset logo, banner and background by specifying `None` as the argument. Below, the custom background is reset and the built-in background is applied. The portal comes with just 1 default background, hence a name is not required to set it."]}, {"cell_type": "code", "execution_count": 10, "metadata": {}, "outputs": [{"data": {"text/plain": ["True"]}, "execution_count": 10, "metadata": {}, "output_type": "execute_result"}], "source": ["gis.admin.ux.set_background(background_file=None, is_built_in=False)"]}, {"cell_type": "code", "execution_count": 11, "metadata": {}, "outputs": [{"data": {"text/plain": ["True"]}, "execution_count": 11, "metadata": {}, "output_type": "execute_result"}], "source": ["gis.admin.ux.set_background(is_built_in=True)"]}, {"cell_type": "markdown", "metadata": {}, "source": ["## Setting featured content\n", "You can designate the contents of a group to show up as featured content on the home page."]}, {"cell_type": "code", "execution_count": 12, "metadata": {}, "outputs": [{"data": {"text/plain": ["[,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ,\n", " ]"]}, "execution_count": 12, "metadata": {}, "output_type": "execute_result"}], "source": ["#get the list of groups in the GIS and select one of the groups\n", "gis.groups.search()"]}, {"cell_type": "code", "execution_count": 13, "metadata": {}, "outputs": [{"data": {"text/html": ["
\n", "
\n", " \n", " \n", " \n", "
\n", "\n", "
\n", " Traffic incident analysis\n", " \n", "
\n", "
Summary: A group to share content and analyze traffic issues using GIS\n", "
Description: A group to share content and analyze traffic issues using GIS\n", "
Owner: admin\n", "
Created: August 08, 2017\n", "\n", "
\n", "
\n", " "], "text/plain": [""]}, "execution_count": 13, "metadata": {}, "output_type": "execute_result"}], "source": ["traffic_group = gis.groups.search()[-1]\n", "traffic_group"]}, {"cell_type": "markdown", "metadata": {}, "source": ["Set the Traffic incident analysis group as featured content."]}, {"cell_type": "code", "execution_count": 19, "metadata": {"collapsed": true}, "outputs": [], "source": ["gis.admin.ux.featured_content = {'group':traffic_group}"]}, {"cell_type": "markdown", "metadata": {}, "source": ["\n", "The home page appears as above after the featured content is set."]}], "metadata": {"kernelspec": {"display_name": "Python 3", "language": "python", "name": "python3"}, "language_info": {"codemirror_mode": {"name": "ipython", "version": 3}, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.2"}, "toc": {"base_numbering": 1, "nav_menu": {}, "number_sections": true, "sideBar": true, "skip_h1_title": false, "title_cell": "Table of Contents", "title_sidebar": "Contents", "toc_cell": true, "toc_position": {}, "toc_section_display": true, "toc_window_display": true}}, "nbformat": 4, "nbformat_minor": 1} \ No newline at end of file +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Customizing the look and feel of your GIS\n", + "\n", + "As an administrator of your GIS, you can configure the appearance of the portal website to make it home for your users. The `UX` class of the `admin` sub module can be used to customize the look and feel of your portal website by setting the name, description, logo, background image, banner image, default basemap, extent etc.\n", + "\n", + "You can use the `UX` class on organizations hosted on ArcGIS Online or ArcGIS Enterprise. To note here, the GIS connection can be created by using username/password, e.g. `gis = GIS(\"portalname.domain.com/webadaptor\", \"username\", \"password\")`, or through an existing profile." + ] + }, + { + "cell_type": "markdown", + "metadata": { + "toc": true + }, + "source": [ + "

Table of Contents

\n", + "
" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "metadata": {}, + "outputs": [], + "source": [ + "from arcgis.gis import GIS\n", + "gis = GIS(profile=\"your_ent_admin_profile\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "When you install ArcGIS Enterprise or create a new organization on ArcGIS Online, it would look similar to the image shown below:" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The rest of this guide walks you through customizing this GIS. As an example, this guide chooses to customize this GIS for Public Works Department of the city of Los Angeles." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Setting name and description\n", + "Use the `name` and `description` to both query and set them on the GIS." + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'LA PWD GIS'" + ] + }, + "execution_count": 2, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.name" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'Spatial information portal for the Public Works Department of the city of Los Angeles'" + ] + }, + "execution_count": 3, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.description" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'This property no longer exists for your organization.'" + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.description_visibility" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "To set new name and description, simply set these properties" + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "True" + ] + }, + "execution_count": 8, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.description = 'Spatial information portal for the Public Works Department of the city of Los Angeles'\n", + "gis.admin.ux.security_settings.securityname = 'LA PWD GIS'\n", + "gis.admin.ux.security_settings.description_visibility = True\n", + "gis.admin.ux.security_settings.set_informational_banner(text=\"LA Public Works GIS\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Once the name and description is set, the portal website looks like below:\n", + "\n", + "\n", + "
Note: The name of the GIS shows up in the browser tab name. Description shows up in the gray bar. To update the large 'ArcGIS Enterprise' text, you need to update the banner image as shown below:
" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Setting logo, banner and background images\n", + "To set the logo, banner and background images, call the `set_logo()`, `set_banner()` and `set_background()` methods. Your GIS might come with a set of built-in images. You can use one of those or upload your own. If using a built-in banner, valid values are `banner-1`, `banner-2`, `banner-3`, `banner-4`, `banner-5` and set the `is_built_in` to `True`. The example below uploads a custom banner and background file from disk." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Python 3.4 introduced a new standard library for dealing with files and paths called `pathlib` — and it’s making things simpler in representing directories and files via absolute or relative paths across different operating systems." + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "True\n" + ] + } + ], + "source": [ + "from pathlib import Path\n", + "\n", + "filename = Path('staticimg/background.jpg')\n", + "if filename.exists():\n", + " print(gis.admin.ux.homepage_settings.set_background(background_file=filename))\n", + "else:\n", + " print(\"file not exists!\")" + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "True\n" + ] + } + ], + "source": [ + "filename = Path('staticimg/logo.png')\n", + "if filename.exists():\n", + " print(gis.admin.ux.homepage_settings.set_logo(logo_file=filename))\n", + "else:\n", + " print(\"file not exists!\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Refershing the portal website will render the new appearance:\n", + "\n", + "\n", + "
Note: Refer the help on configuring home page to understand the dimensions of the images for best appearance. You can also pass custom HTML code while setting the banner. To learn more about that refer here.
\n", + "\n", + "### Download existing customizations\n", + "You can download the current banner, logo, background values using the corresponding `get` methods" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'text': 'LA Public Works GIS', 'bgColor': 'white', 'fontColor': 'black', 'enabled': False}\n" + ] + } + ], + "source": [ + "dirname = Path('staticimg/downloads')\n", + "try:\n", + " print(gis.admin.ux.security_settings.get_informational_banner())\n", + "except Exception as ex:\n", + " print(str(ex))" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Resetting customization\n", + "You can reset logo, banner and background by specifying `None` as the argument. Below, the custom background is reset and the built-in background is applied. The portal comes with just 1 default background, hence a name is not required to set it." + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "True" + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.homepage_settings.set_background(background_file=None, is_built_in=False)" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "True" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.homepage_settings.set_background(is_built_in=True)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Setting featured content\n", + "You can designate the contents of a group to show up as featured content on the home page." + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "[,\n", + " ,\n", + " ,\n", + " ,\n", + " ,\n", + " ]" + ] + }, + "execution_count": 19, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "#get the list of groups in the GIS and select one of the groups\n", + "gis.groups.search()" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "
\n", + " \n", + " \n", + " \n", + "
\n", + "\n", + "
\n", + " Dictionary Symbology Styles\n", + " \n", + "
\n", + "
Summary: Styles to support dictionary symbology use throughout ArcGIS.\n", + "
Description:

This page gives you access to the latest Military Dictionary Styles for use in the ArcGIS Maps SDKs for Native Appsand the ArcGIS Maps SDK for JavaScript, and ArcGIS Pro. These styles contain the data that the dictionary renderer uses to display military standard symbology in custom applications.

 

Dictionary styles are currently provided for the following United States and NATO standards:

 

  • MIL-STD-2525E
  • MIL-STD-2525D w/CHANGE 1
  • MIL-STD-2525D
  • MIL-STD-2525C
  • MIL-STD-2525B w/CHANGE 2
  • APP-6(E)
  • APP-6(B)
  • APP-6(D)
\n", + "
Owner: esri_webstyles\n", + "
Created: February 13, 2024\n", + "\n", + "
\n", + "
\n", + " " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 15, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "traffic_group = gis.groups.search()[3]\n", + "traffic_group" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Set the Traffic incident analysis group as featured content." + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "{'group': ''}" + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "gis.admin.ux.featured_content = {'group':traffic_group}" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "\n", + "The home page appears as above after the featured content is set." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Pixi Local", + "language": "python", + "name": "local" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.13.11" + }, + "toc": { + "base_numbering": 1, + "nav_menu": {}, + "number_sections": true, + "sideBar": true, + "skip_h1_title": false, + "title_cell": "Table of Contents", + "title_sidebar": "Contents", + "toc_cell": true, + "toc_position": {}, + "toc_section_display": true, + "toc_window_display": true + } + }, + "nbformat": 4, + "nbformat_minor": 4 +}