webmap-hover-template v0.0.13

Configuration Options

General options

• appid: Application id that contains configured app properties

View comparision options

• webmap: Web map or scene for first map panel
• webscene: Web map or scene for second map panel
• webmapDesc: Title and/or small amount of descriptive text for map1.
• websceneDesc: Title and/or small amount of descirptive text for map2
• descPosition": Valid values are top-left|top-right|bottom-left|bottom-right. The location on the map where the descriptive text displays
• splitDirection: horizontal|vertical Horizontal displays maps side by side. Vertical stacks maps.
• expand: Add an expand button to each map so users can quickly expand/collapse the map to view it full size.
• expandPosition: Valid values are top-left|top-right|bottom-left|bottom-right. The location on the map where the expand button is added. The default value is bottom-right.

Title and Toolbar options

• title: Main title for the app
• titlelink: Url if you want the title to be a clickable link that navigates to the specified site.
• headerPosition: top|bottom Determines the positioning of the title and toolbar content.
• header: true|false When true the header area is hidden and any header tools that have been enabled are added to the app

Splash or Info panel

Use these options to add a modal with descriptive info and/or a button with info to the app. The info/splash button is added to the title area of the app unless header is false. If header is false the button is added to the top-right corner of the first view.

• splash: Add info button to the app
• splashOnStart: Display the information as a splash screen when the app loads. Once the user closes the splash screen we write a property to session storage so the modal isn't displayed again during that session. When false the modal doesn't display and the info content is added as a button.
• splashDesc: Content that displays in the description area of the info panel.
• splashTitle: Title for the info panel
• splashButtonLabel: Text that displays on the info panel. The default value is ok.

Popup Settings

• autoDockPopup: When false the default responsive behavior of the popup is disabled and the popup will display docked in the specified location.
• dockPosition: Specify the docked location of the popup. Only valid when autoDockPopup is set to false. Default location is bottom-center. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• dockButton: When false the dock button is disabled on the popup so user's can't dock/undock the popup window.
• popupDisplayAttachmentType: Specify the way image attachments are displayed in the popup . Valid options are preview|list. Default value is list (added at 4.11)

3d View Settings

• sceneBackgroundColor: Specify a hex color value for the scene background. When set the atmosphere and stars are turned off so the background of the scene will be drawn in the specified color.

Synchronize Views

• syncViews: Default value is true. When true the maps are synchronized. When false maps work independently.
• syncPopup: Default value is true. When true the popups are synchronized between maps.

Theme

• bodyBackground: Default value is empty. If a shared theme is set in the organization the body.background color will be used. Users can specify a color via the configuration process. This color will be used for the splash and description panel background color.
• bodyColor: Default value is empty. If a shared theme is set in the organization the body.text color will be used. Users can specify a color via the configuration process. This color will be used for the splash and description panel text color.
• headerBackground: Default value is white (#fff). If a shared theme is set in the organization the header.background color will be used. Users can specify a color via the configuration process. This color will be used for the header/footer background color.
• headerColor: Default value is dark gray (#4c4c4c). If a shared theme is set in the organization the header.text color will be used. Users can specify a color via the configuration process. This color will be used for the header/footer text color and the color of any tools that are displayed in the header/footer area.
• buttonBackground: Default value is empty. If a shared theme is set in the organization the button.background color will be used. Users can specify a color via the configuration process. This color will be used for the splash screen button background color. Note: This value is not applied to map buttons.
• buttonColor: Default value is empty. If a shared theme is set in the organization the button.text color will be used. Users can specify a color via the configuration process. This color will be used for the splash screen button text color. Note: this value is not applied to map buttons.

Tools

• search: Default value is false. If the maps are sync'd and the header is displayed we'll just add one search widget to the header area that will allow searching of both maps. If maps are not sync'd then we'll add a search widget to each map.
• searchPosition: Location on the map where the search button is displayed. Only applies if its not in the header. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• legend: Default value is false. When true a legend button is added to each view unless the views are pointing to the same map/scene.
• legendPosition: Location on the map where the legend button is displayed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• bookmark: Default value is false. When true displays bookmarks for the 2d map and slides for the 3d map. If no slides or bookmarks are present in the map then the tool isn't added to the map.
• bookmarkPosition: Location on the map where the bookmark or slide tool is placed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• home: Default value is false. When true a home button is added to the maps.
• homePosition: Location on the map where the home tool is placed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• measure: Default value is false. When true the measure button is added for 3d and 2d maps.
• measurePosition:Location on the map where the measure tool is placed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• measureOptions: Valid values are both|line|area. Allows users to display just the line and area tools or add both.
• scalebar: Default value is false. When true a scalebar is added to 2d maps. If both maps are 2d and view is synced only add scalebar to first map.
• scalebarPosition:Location on the map where the scalebar is placed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• share: Default value is false. When true a share button is added to the maps. If the maps are synced only add the share button to the first map.
• sharePosition:Location on the map where the share button is placed. Valid values are top-left|top-center|top-right|bottom-left|bottom-center|bottom-right
• shareIncludeServices: Default value is false. When true social media sharing (Twitter, FB etc) is enabled.
• shareIncludeCopy: Default value is true. When true share dialog contains a link to the share url and a copy button.

Time

• time: When true the time slider widget will be added if the web map has time info
• timeMode: Select one of the available time modes. By default time-window is used if two sliders were defined. If only one defined cumulative-from-start is used.
• timeLoop: When true the time slider will loop back to the beginning when the end time is reached. Default value is false.
• timeVisible : When true the time component of the date is added to the label. Default value is true.
• timePosition: The corner of the application where the slider is placed. Default value is bottom-left.
• timeExpandAtStart: Open the time slider when the app opens. Default value is false.
• timeEffect: Apply a css filter effect to the included or excluded layers. Default value is false.
• includedEffect: Choose one of the preset effects to apply to features within the current time extent. Default value is null. Available options are saturate | contrast | brightness | null.
• excludedEffect: Choose one of the preset effects to apply to features that are NOT included in the time extent. Default value is null. Available options are gray | sepia | opacity