Crear un botón de add-in de Python
Crear un botón de add-in de Python
Un botón es la forma más simple de personalización que se puede utilizar para ejecutar alguna lógica de negocios haciendo clic en él.
Este tema le guía a través del proceso de creación de un botón en una nueva barra de herramientas mediante el Asistente de add-in de Python. Antes de comenzar este flujo de trabajo, asegúrese de haber creado un proyecto add-in de ArcMap y de haber especificado la configuración del proyecto. Para obtener más información, consulte Crear un proyecto de add-in. Si bien este flujo de trabajo muestra cómo crear un botón para ArcMap, puede utilizar este proceso para agregar un botón a cualquier aplicación ArcGIS for Desktop . Este tema examina el proceso de creación de un botón simple Acercar Entidades seleccionadas. A continuación se examina con mayor detalle la clase de Python creada por el Asistente para explorar las propiedades y métodos que proporcionan funcionalidad a su botón.
La creación de un botón de add-in consta de los siguientes pasos:
- Crear una barra de herramientas o menú
Una vez que haya introducido la configuración necesaria del proyecto, haga clic en la pestaña Contenido de Add-in y empiece manifestando su personalización de add-ins. El botón puede situarse en una barra de herramientas o un menú. En este ejemplo, se crea una nueva barra de herramientas que contenga al botón. Consulte Crear una barra de herramientas de add-ins para ver los pasos necesarios para crear su propia barra de herramientas.
- Cree el botón
Una vez que haya introducido las propiedades de la barra de herramientas, puede crear un botón nuevo. Haga clic con el botón derecho en la nueva barra de herramientas denominada "Barra de herramientas" y seleccione Nuevo Botón.
El botón tiene gran cantidad de propiedades que usted debe introducir. La siguiente es una lista de todas las propiedades con una explicación para cada una. Estas propiedades se almacenan en el archivoconfig.xml del proyecto.
Propiedad
Descripción
Título (necesario)
Define el título del botón. La siguiente ilustración muestra el título utilizado en el Administrador de add-ins de ArcGIS para ayudar a identificar los diferentes tipos de personalizaciones disponibles (el tipo de add-in se identifica entre paréntesis):
La siguiente ilustración muestra el título utilizado como texto para identificar el botón en la barra de herramientas:
Clase(necesaria)
La clase de Python que se ejecuta cuando se hace clic en el botón en una aplicación de escritorio. La clase de Python es donde usted escribe su lógica de negocios para el botón. Utilice la convención de denominación en mayúsculas de Python cuando construya su clase (por ejemplo, "Acercar a las Entidades Seleccionadas" en lugar de "acercar a las entidades seleccionadas" .
Id.(necesario)
Un nombre particular que se utiliza para identificar el botón. Es posible crear más de un botón para un determinado proyecto y este Id. se utiliza para distinguir entre los diferentes botones. Lo ideal sería que usted sustituyera el ID predeterminado con un valor más significativo. El Id. no debe tener espacios. Puede utilizar guiones bajos para unir palabras. No debe utilizar palabras clave de Python. Consulte la documentación de Python en relación a las palabras reservadas.
Información sobre herramientas (opcional)
Una breve descripción que aparece cuando detiene el puntero del ratón sobre el botón en una aplicación de escritorio.
Mensaje (opcional)
Una descripción detallada de lo que hace el botón. El mensaje que aparece debajo de información sobre herramientas cuando detiene el puntero del ratón sobre el botón.
Imagen (opcional)
Debería ser una imagen de 16 x 16 píxeles utilizada para simbolizar el botón. El formato de imagen debe ser uno de los que se utilizan habitualmente (es decir, .bmp, . jpg, etc.). La imagen se copiará a la carpeta de imágenes creada en su proyecto de add-in.
La parte final del botón es el título y el contenido de Ayuda. Estas propiedades le permiten proporcionar la información que se utilizará cuando un usuario inicie la ayuda contextual. Estos son temas emergentes que permanecen en pantalla hasta que el usuario haga clic en otro lugar.
Las siguientes propiedades conforman la sección de ayuda contextual:
Propiedad
Descripción
Encabezamiento (opcional)
Indica de qué trata el contenido de la ayuda.
Contenido (opcional)
El contenido de la ayuda para el botón.
Una vez que haya terminado de introducir las propiedades, puede hacer clic en el botón Guardar en la parte inferior del asistente. De esta forma se crearán todos los archivos y carpetas necesarios dentro de su carpeta de trabajo.
- Editar la secuencia de comandos de Python.
En esta fase, ha terminado de agregar los valores a las propiedades necesarios para definir el botón de add-in. El siguiente paso en este flujo de trabajo es editar la secuencia de comandos de Python y actualizar la clase de Python para incluir la funcionalidad de acercar las entidades seleccionadas. Si no hay entidades seleccionadas, se acerca toda la extensión de todas las capas. Para agregar la funcionalidad al botón personalizado, realice los siguientes pasos:
- Edite la secuencia de comandos de Python en la carpeta Instalar que se encuentra en la carpeta de trabajo que usted creó sirviéndose del asistente.
Existirá una clase con el mismo nombre que el de la propiedad Clase que introdujo anteriormente. No debería cambiar el nombre de esta clase , ya que se hace referencia al nombre de clase en el archivo config.xml. En relación a la explicación de cada función y propiedad de la clase, consulte el tema Clase de botón .
- Agregue el siguiente código de la secuencia de comandos en la función onClick (self).
Este código proporciona la funcionalidad de acercar las entidades seleccionadas.
# Implementation of OnClick method of Button's class def onClick(self): # Get the current map document and the first data frame. mxd = arcpy.mapping.MapDocument('current') df = arcpy.mapping.ListDataFrames(mxd)[0] # Call the zoomToSelectedFeatures() method of the data frame class df.zoomToSelectedFeatures() - Guarde la secuencia de comandos.
- Edite la secuencia de comandos de Python en la carpeta Instalar que se encuentra en la carpeta de trabajo que usted creó sirviéndose del asistente.
- Probar el botón
Una vez que haya creado el botón y haya agregado su código de la secuencia de comandos, es importante hacer el archivo add-in y probar el add-in antes de compartirlo. Para más información sobre estos pasos, consulte Probando un add-in.
- Compartir el add-in
Después de probar el botón y confirmar que funciona como se espera, usted ya está listo para implementar y compartir el add-in. Para obtener más información, consulte Compartir add-ins.