Descripción

• extent (extensión): una propiedad obligatoria que define la extensión del mapa. La referencia espacial del objeto de extensión es opcional; cuando no se proporciona, se asume que está en la referencia espacial del mapa. Cuando la relación de aspecto de la extensión de mapa es diferente que el tamaño del mapa en la página de salida o el exportOptions:outputSize, es posible que observe más entidades en el mapa de salida.
• scale (opcional): la escala de mapa a la que desee exportar el mapa. Esta propiedad es opcional pero se recomienda para obtener los mejores resultados. La propiedad de escala es especialmente útil cuando los servicios de mapas en este mapa Web tienen capas dependiente de la escala o escalas de referencia establecidas. Debido a que el mapa que está visualizando en la aplicación Web puede ser más pequeño que el tamaño del mapa de salida (por ejemplo, 8,5 x 11 pulgadas o tamaño A4), la escala del mapa de salida será diferente y podrá ver las diferencias en entidades y símbolos de la aplicación Web en comparación con el mapa de salida.

  Cuando se utiliza la escala, prevalece sobre la extensión, pero el mapa de salida se dibuja en la escala solicitada al centro de la extensión.

• rotation (opcional): esta opción representa el número de grados en que se girará el marco de datos, medido en sentido contrario a las agujas del reloj desde el norte. Para rotar en el sentido de las agujas del reloj, utilice un valor negativo.
• spatialReference (opcional): la referencia espacial del mapa. El orden de preferencia cuando falta spatialReference, es el siguiente:
  1. mapOptions.extent.spatialReference
  2. baseMap.baseMapLayers.spatialReference
  3. Referencia espacial de la plantilla de mapa
• time (opcional): si existe una capa sensible al tiempo y desea que se dibuje en un momento determinado, especifique esta propiedad. Esta lista ordenada puede tener uno o dos elementos. Agregar dos elementos (startTime seguido por endTime) para representar una extensión de tiempo o proporcionar un solo elemento de tiempo para representar un instante de tiempo. Los tiempos siempre están en UTC.
• background (opcional): puede cambiar el color de fondo del mapa. Cuando hay más de un mapa en una disposición, se aplica al mapa asociado a un marco de mapa denominado WEBMAP_MAP_FRAME.

Descripción

• id (opcional): una cadena de caracteres que identifica de manera única una capa operacional. Esto es necesario en su mayor parte para leyendas.
• url: el punto final de un servicio. No es necesario para "featureCollection".
• token (opcional): un token para acceder a un servicio protegido.
• title (opcional): nombre de una capa operacional. Si se muestra en la leyenda, la leyenda en el diseño debe admitirlo.
• visibility (opcional): el valor predeterminado es true.
• opacity (opcional): los rangos de valores del 0 al 1 (valor predeterminado); 1 significa totalmente opaco y 0 significa totalmente transparente.
• minScale (opcional): la capa no se dibujará si se aleja más allá de esa escala.
• maxScale (opcional): la capa no se dibujará si se acerca más allá de esa escala.

Descripción

• visibleLayers (opcional): conjunto de Id. de subcapas que deben estar visibles en la capa de servicio de mapas. Si esto se omite, la capa operacional se dibuja con los estados visibles predeterminados de cada subcapa. No es necesario especificar el Id. de capa de grupo. Tenga en cuenta que si un servicio de mapas es compatible con capas dinámicas, la configuración de layers tendrá prioridad sobre visibleLayers. Los servicios de mapas que no utilizan dynamicLayers, solamente son compatibles con la propiedad layerDefinition de layers.
• layers (opcional): lista de las capas a exportar. En los servicios de mapas que utilizan capas dinámicas serán exportadas todas las capas especificadas en el conjunto layers, omitiéndose la opción visibleLayers. Use la propiedad name para definir un nombre para una capa. Normalmente, será necesario si el tipo source de la capa es dataLayer.
• drawingInfo (opcional): utilice esta opción para sustituir los ajustes de dibujo de una subcapa, por ejemplo, el renderizador de la subcapa.
  • renderer (opcional): si se especifica, sustituye el renderizador original de la subcapa.
• source (opcional): representa el origen de una capa que se agrega al servicio de mapas dinámicamente a solicitud. Consulte la API REST de ArcGIS para obtener más información sobre cómo definir la fuente.
• gdbVersion (opcional): especifique esta opción si desea ver las entidades dibujadas desde una versión de geodatabase diferente. Puede definirlo en un nivel de capa operacional para alternar todas las capas a la versión especificada o definir como una subcapa en un conjunto layers para cambiar la versión de la geodatabase para cualquier capa individual.

Descripción

• url (obligatoria): la dirección URL de la capa. Esta propiedad debe finalizar con /dynamicLayer si una capa de entidades está basada en una capa de un servicio de mapas que utiliza capas dinámicas.
• drawingInfo (opcional): especifica el renderizador para esta capa.
  • Para representar en pantalla utilizando un renderizador temporal, especifique las propiedades latestObservationRenderer, trackLinesRenderer y observationAger aparte del renderizador.
  • observationAger (opcional): el renderizador temporal admite dos tipos de observationAger: rampAger y classBreaksAger. Para cualquier solicitud determinada, una capa puede contener un elemento rampAger o classBreaksAger, pero no ambos.
• definitionExpression (opcional): sentencia SQL que limita qué entidades se dibujarán.
• objectIds (opcional): limita qué entidades se dibujan, en función de los Id. de los objetos.
• timeInfo (opcional):
  • trackIdField: campo que representa de forma exclusiva uno o varios objetos determinados que se están observando. Si este campo está vacío o no existe, solo se dibujará la última observación, utilizando la propiedad latestObservationRenderer.
• geometry (opcional): limita las entidades que debe dibujar una geometría.
• geometryType (opcional): esta opción es obligatoria si se especifica una geometría.
• spatialRel (opcional): relación espacial que se aplicará en la geometría de entrada mientras se realiza la consulta.
• relationParam (opcional): función de relación espacial que puede aplicarse al realizar la consulta. Un ejemplo de esta función de relación espacial es FFFTTT***.
• selectionObjectIds (opcional): resalta las entidades con determinados Id. de objeto y el símbolo proporcionado; es necesario configurar selectionSymbol.
• selectionSymbol (opcional): se resaltarán las entidades que tengan este símbolo. Esta opción es obligatoria si se especifica selectionObjectIds.
• gdbVersion (opcional): especifica un nombre de versión de la geodatabase si se utiliza una versión distinta de aquella a la que haga referencia el servicio de entidades o de mapas.
• source (opcional): esta opción solamente será necesaria si una capa de entidades está basada en un servicio de mapas que utiliza capas dinámicas.

Descripción

Descripción

• type (obligatorio): para capas WMS debe especificarse como wms.
• format (opcional): formato de imagen solicitado del servidor.
• transparentBackground (opcional): si esta opción se configura como true, el fondo se tornará transparente, siempre y cuando el formato de imagen solicitado sea compatible con colores transparentes. (JPEG es un ejemplo de un formato de imagen que no es compatible con un color transparente). El valor predeterminado es false.
• visibleLayers (opcional): conjunto de nombres de subcapas que deben estar visibles en la capa de servicio WMS. El orden también es importante; el orden debe cumplir con los requisitos del servicio WMS. Cuando no se encuentren, todas las capas del servicio WMS será visible.
• layers (opcional): conjunto de nombres de subcapas que se agregarán al mapa. Si no se proporciona, todas las capas de un servicio WMS se agrega al mapa.
• styles (opcional): utilice esta opción para suprimir un estilo de dibujo predeterminado de subcapa. Si se especifica, asegúrese de que el número y el orden de los estilos coincidan con el conjunto visibleLayers. Si no se desea cambiar el estilo de una subcapa en particular, se puede pasar una cadena vacía, por ejemplo, "styles": ["highways","","population"].
• version (opcional): la versión de WMS a la que desee conectarse. El valor predeterminado es la última versión compatible con el servicio WMS determinado.

Descripción

• type (obligatorio): para este tipo de capa, el tipo debe ser kml.
• url (obligatorio): URL para un archivo kmz.
• showLabels (opcional): de forma predeterminada es false.
• visibleFolders: matriz de Id. numéricos de carpetas que serán visibles.

Descripción

• type (obligatorio): para este tipo de capa, el type debe ser image.
• extent (obligatorio): caja de límite mínima adecuada para la imagen.
• url (opcional): dirección URL de la imagen que desee dibujar. Esto solo es necesario cuando imageData no está aprobada.
• imageData (opcional): la imagen está codificada como base64. Esto es necesario cuando no se pasa la propiedad url.

Descripción

• layers (obligatorio): colección de capas. Una capa tiene dos propiedades: layerDefinition y featureSet.
• layerDefinition (obligatorio): contiene propiedades que definen una capa: name, geometryType, drawingInfo, objectIdField y fields.
• name (opcional): nombre de la capa.
• geometryType (obligatorio): en el caso de una capa de texto, el valor de geometryType debe ser esriGeometryPoint.
• drawingInfo (opcional): si falta drawingInfo, los gráficos se representarán utilizando el símbolo.
• objectIdField (opcional): nombre del campo que contiene Id. de objeto.
• fields (opcional): conjunto de campos.
• featureSet (obligatorio): contenedor de entidades.
• features (obligatorio): colección de entidades.
• geometry (obligatorio): la geometría que define la entidad o el gráfico.
• attributes (opcional): conjunto de atributos de entidades.
• symbol (opcional): si se especifica, este símbolo sustituirá el definido en el renderizador.

Descripción

• latitudeFieldName (obligatorio): el nombre del campo que contiene la coordenada Y.
• longitudeFieldName (obligatorio): el nombre del campo que contiene la coordenada X.

Descripción

• url (opcional): si no se especifica, se usa openstreetmap.org de forma predeterminada.
• credits (opcional): mención opcional que indica quién contribuyó a la capa. El valor de esta propiedad se omite cuando no se especifica url. En su lugar, se utilizan los créditos para el servicio OpenStreetMap predeterminado.

Descripción

• urlTemplate (obligatoria): plantilla de dirección URL para recuperar las teselas. La plantilla de URL sigue el patrón https://some.domain.com/{level}/{col}/{row}/, donde level corresponde a un nivel de zoom, y col y row representan, respectivamente, la columna y la fila de las teselas.
• subDomains (opcional): uno de los subDomains especificados se utilizará para reemplazar el marcador de posición {subDomain} en la urlTemplate para formar una URL de solicitud de tesela.
• tileInfo (opcional): define la información de tesela para la capa, incluidos LOD, filas, columnas, origen y referencia espacial. Si no se proporciona tileInfo, se supone que la capa está en Web Mercator con el esquema de ordenamiento en teselas de Web Mercator. Para obtener información sobre tileInfo, consulte la API de REST ArcGIS.
• credits (opcional): mención opcional que indica quién contribuyó a la capa.

Descripción

• dpi (opcional): la resolución, en puntos por pulgada. El valor predeterminado es 96 dpi.
• outputSize (opcional): tamaño de la imagen, en píxeles. Debe definirse el tamaño cuando una cadena de caracteres vacía o MAP_ONLY (sin comillas) se pase como valor al parámetro layout_template. Si no se especifica layout_template como MAP_ONLY o una cadena de caracteres vacía, layout_template prevalece sobre outputSize.

Descripción

• titleText (opcional): el texto del elemento de texto del título del mapa se actualizará si existe en el diseño.
• authorText (opcional): el texto del elemento de texto del autor se actualizará si existe en el diseño.
• copyrightText (opcional): el texto del elemento de texto del copyright se actualizará si existe en el diseño.
• scaleBarOptions (opcional): actualizarán una barra de escala si existe alguna.
  • metricUnit (opcional): configura las unidades de la barra de escala como unidades métricas.
  • metricLabel (opcional): cadena de caracteres que indica cómo deben etiquetarse las unidades; por ejemplo, KM, kilómetros o km. Cuando no se especifica o se aprueba una cadena de caracteres vacía, se utiliza el valor de texto de la unidad.
  • nonMetricUnit (opcional): configura las unidades de la barra de escala como unidades métricas.
  • nonMetricLabel (opcional): cadena de caracteres que indica cómo deben etiquetarse las unidades; por ejemplo, millas o mi. Cuando no se especifica o se aprueba una cadena de caracteres vacía, se utiliza el valor de texto de la unidad.
• customTextElements (opcional): es un conjunto de pares nombre-valor. Debe utilizar esta opción si desea actualizar el texto de un elemento de texto (que no es texto dinámico) en el diseño de página. Los valores deben ser de cadenas de caracteres.
• legendOptions (opcional): especifica las propiedades de un elemento de leyenda en el diseño. Observe que cuando un elemento de leyenda en un diseño se encuentra vacío (no tiene una capa en él), es eliminado por el servicio de impresión.
  • operationalLayers (opcional): especifica las capas operacionales cuyas leyendas se agregarán al diseño.
    • id: cadena de caracteres que representa el Id. de la capa. El Id. debe ser único y debe coincidir con el Id. de la capa en el elemento operationalLayers donde se define la capa operacional.
    • subLayerIds (opcional): un conjunto de subcapas cuyos tipos de elementos son cadenas de caracteres o largos y contextuales para el tipo de capa operacional. Por ejemplo, para una capa de servicio de mapas, debe ser un número; para una capa WMS, debe ser una cadena de caracteres. Se recomienda que especifique los valores subLayerIds para las capas operacionales que tengan subcapas. Una vez omitido, en el caso del servicio de mapas y las capas WMS, se agregan las leyendas de todas las subcapas al elemento de leyenda en el diseño. Para capas de entidades o gráficos, no es necesario establecer la propiedad de las subcapas.