Share

ACAD Namespace

Functions

  Name Description
Member Type, Function Acad.Application This is a singleton class that provides services for accessing the active document object.
Member Type, Function Acad.Application.activedocument.capturePreview Use this method to capture an image of the current document. The image is returned as a Base64 encoded bitmap. This function returns a promise pattern result, it has to be called as a Promise Pattern with .then(onSuccess, onError) function.
Member Type, Function Acad.Application.activedocument.getHandle Use this method to get an array of handles from the OSet. This function returns a promise pattern result, it has to be called as a Promise Pattern with .then(onSuccess, onError) function.
Member Type, Function Acad.Application.activedocument.getObjectSet Use this function to get the array of object IDs from the handles. This function returns a promise pattern result, it has to be called as a Promise Pattern with .then(onSuccess, onError) function.
Member Type, Function Acad.Application.activedocument.highlight Use this function to highlight the list of entities represented by the given OSet.
Member Type, Function Acad.Application.activedocument.startObserving Use this function to subscribe to object event notifications for an object.
Member Type, Function Acad.Application.activedocument.stopObserving Use this function to unsubscribe from receiving object event notifications for an object.
Member Type, Function Acad.Application.activedocument.transientManager Use this function to get the Transient Manager object of the current drawing.
Member Type, Function Acad.Application.activedocument.unhighlight Use this function to unhighlight the list of entities represented by the given OSet.
Member Type, Function Acad.Application.addDocWindow Use this function to open a HTML document window in AutoCAD.
Member Type, Function Acad.Application.addPalette Use this method to launch a palette with the specified URL.
Member Type, Function Acad.Application.displayContextMenu Use this function to display a contextual menu in AutoCAD.
Member Type, Function Acad.Application.modalDialogCommit Use to set the commit state of the modal dialog.
Member Type, Function Acad.Application.showHTMLDialog Use this function to show a HTML dialog with the specified URL.
Member Type, Function Acad.Application.showModalDialog Use this function to launch a modal dialog with the specified URL.
Member Type, Function Acad.Bounds3d The object represents the 3D geometric extents of an entity. It is similar to AcDbExtents, with minimum and maximum points.
Member Type, Function Acad.CommandFlag Use this enum to list the flag associated with AutoCAD command.
Member Type, Function Acad.CursorType Provides the type of cursor, which are available. This enum wraps the AcEdJig::CursorType ObjectARX enum.
Member Type, Function Acad.DataItem This is the class that represents object type inside Acad.DataItemCollection.
Member Type, Function Acad.DataItem.getProperties Returns all the properties of DataItem class.
Member Type, Function Acad.DataItemCollection This is the class that represents a dataItems collection. It is returned by DataItemCollectionManager.getKnownCollection(). You can observe dataItemCollection changes through add/removeEventListener function.
Member Type, Function Acad.DataItemCollection.addEventListener Use this function to add event listeners for the Acad.DataItemCollection class.
Member Type, Function Acad.DataItemCollection.getName Use this function to get the name of the Acad.DataItemCollection class.
Member Type, Function Acad.DataItemCollection.removeEventListener Use this function to remove event listeners for the Acad.DataItemCollection class.
Member Type, Function Acad.DataItemCollectionManager This is the class that represents DataItemCollection Manager.
Member Type, Function Acad.DataItemCollectionManager.getKnownCollection Use this asynchronous function to get a known collection.
Member Type, Function Acad.DBEntity The object represents a database resident entity.
Member Type, Function Acad.DBEntity.getExtents Returns the object geometric extents defined by minimum and maximum points.
Member Type, Function Acad.DBEntity.getProperties Returns all the properties of DBEntity.
Member Type, Function Acad.DragCursor Use this enum to list the cursor types that may be used while dragging.
Member Type, Function Acad.DragStatus Use this enum to list the status types that may be used while dragging.
Member Type, Function Acad.DrawJig This class represents jig class for drawing transient jigging.
Member Type, Function Acad.DrawJig.update Adds or updates transient entity during jigging.
Member Type, Function Acad.Editor.addCommand Use this method to register an AutoCAD command.
Member Type, Function Acad.Editor.cancelCommand Use this method to cancel the last command.
Member Type, Function Acad.Editor.CurrentViewport Represents the current viewport and stores view properties like camera position, target, fieldheight, fieldWidth, upVector, and projection.
Member Type, Function Acad.Editor.CurrentViewport.dolly Use this function to translate the camera target and position by the specified camera space dolly vector. All other camera parameters are left unaffected.
Member Type, Function Acad.Editor.CurrentViewport.getViewport Use this function to retrieve the extents of the viewport in normalized device coordinates.
Member Type, Function Acad.Editor.CurrentViewport.getViewProperties Use this function to return the position, target, upVector, fieldWidth and fieldHeight of current Viewport.
Member Type, Function Acad.Editor.CurrentViewport.orbit Use this function to orbit the camera.
Member Type, Function Acad.Editor.CurrentViewport.pan Use this function to pan the camera.
Member Type, Function Acad.Editor.CurrentViewport.pointToScreen Use this function to return the 2D point on the screen.
Member Type, Function Acad.Editor.CurrentViewport.pointToWorld Use this function to return the 3D point on the world coordinate system.
Member Type, Function Acad.Editor.CurrentViewport.roll Use this function to rotate the camera’s up vector about the eye vector by a specified amount, in radians.
Member Type, Function Acad.Editor.CurrentViewport.setView Use this method to set the camera parameters needed to define the transformation from world space to normalized device coordinates.
Member Type, Function Acad.Editor.CurrentViewport.ucsToWorld Converts a UCS point to WCS.
Member Type, Function Acad.Editor.CurrentViewport.worldToUCS Converts a WCS point to UCS.
Member Type, Function Acad.Editor.CurrentViewport.zoom Changes the viewing field (the focal length) of the camera to give the effect of dynamically moving in or out of a scene.
Member Type, Function Acad.Editor.CurrentViewport.zoomExtents Use this function to modify the current view such that the input bounding box defined by the two extents points is completely within the view.
Member Type, Function Acad.Editor.CurrentViewport.zoomWindow Use this function to modify the current view such that the new window displays the region defined by the input screen coordinates.
Member Type, Function Acad.Editor.drag Use this method to drag a transient entity during jigging.
Member Type, Function Acad.Editor.executeCommand This method accepts variable number of string arguments, which are the commands passed to native environment and it waits for the command operation to complete.
Member Type, Function Acad.Editor.executeCommandAsync This method accepts variable number of string arguments, which are the commands passed to native environment and it does not wait for the command operation to complete.
Member Type, Function Acad.Editor.getAngle Use this function to get user input for an angle, taking into account the current value of the ANGBASE system variable.
Member Type, Function Acad.Editor.getCorner Use this function to get user input for the corner of a rectangle.
Member Type, Function Acad.Editor.getDistance Use this function to get user input for a linear distance.
Member Type, Function Acad.Editor.getDouble Use this function to get the double from an user.
Member Type, Function Acad.Editor.getEntity Use this function to select an entity by specifying a point.
Member Type, Function Acad.Editor.getInteger Use this function to get the integer from an user.
Member Type, Function Acad.Editor.getKeywords Use this function to get an user input for a keyword.
Member Type, Function Acad.Editor.getNestedEntity Use this function to get the name of an entity selected by an user and the point used to select the entity.
Member Type, Function Acad.Editor.getPoint Use this function to get user input for a point.
Member Type, Function Acad.Editor.getSelection Use this to return the selection set obtained.
Member Type, Function Acad.Editor.getString Use this function to get an user input for string.
Member Type, Function Acad.Editor.isQuiescent Use this function to check if the host is busy processing other commands.
Member Type, Function Acad.Enum_Projection Use this enum to provide values that describe the mapping projection of the mapper.
Member Type, Function Acad.ErrorStatus This is an error status defined for Shaping Layer.
Member Type, Function Acad.isInteger Use this function to test whether the number passed is an integer.
Member Type, Function Acad.isNumber Use this function to test whether the number passed is a valid float.
Member Type, Function Acad.Jig This class represents the base jig class.
Member Type, Function Acad.JigPromptAngleOptions This class represents optional parameters for prompt for angle during jigging.
Member Type, Function Acad.JigPromptDistanceOptions This class represents optional parameters for prompt for distance during jigging.
Member Type, Function Acad.JigPromptGeometryOptions This is the base class for jig prompt options used in various types of data acquisition.
Member Type, Function Acad.JigPromptOptions This is the base class for jig prompt options.
Member Type, Function Acad.JigPromptPointOptions This class represents optional parameters for prompt for point during jigging.
Member Type, Function Acad.JigPromptStringOptions This class represents optional parameters for prompt for string during jigging.
Member Type, Function Acad.Matrix3d This class wraps the AcGeMatrix3d ObjectARX class. Matrix3d represents an affine transformation of 3D space, including translation.
Member Type, Function Acad.Menu Use this function to add menu items to a contextual menu.
Member Type, Function Acad.MenuItem Use this function to define a menu item to add to a contextual menu.
Member Type, Function Acad.OSet The object contains a collection of object identifiers. It is similar to ads_name, and valid only while you are working on a drawing with AutoCAD. The identifiers are invalid when exiting from AutoCAD or switching to another drawing.
Member Type, Function Acad.OSet.add Use this method to add the input object id to the collection.
Member Type, Function Acad.OSet.clear Use this method to remove all the IDs from the collection.
Member Type, Function Acad.OSet.contains Use this method to to test if the ID is present in the collection.
Member Type, Function Acad.OSet.getAllIds Use this method to return all the IDs in the collection.
Member Type, Function Acad.OSet.getCount Use this method to return the number of items in the collection.
Member Type, Function Acad.OSet.getId Use this method to return the id given the index of the item in the collection.
Member Type, Function Acad.OSet.indexOf Use this method to return the index of the input ID in the collection.
Member Type, Function Acad.OSet.remove Use this method to remove the input object ID from the collection.
Member Type, Function Acad.Point2d This class wraps AcGePoint2d ObjectARX class. It represents a point in 2-dimensional space. It can be viewed as a structure consisting of two doubles.
Member Type, Function Acad.Point3d This class wraps AcGePoint3d ObjectARX class. It represents a point in 3-dimiensional space. It can be viewed as a structure consisting of three doubles.
Member Type, Function Acad.Promise This is the base class, designed to achieve Promise Pattern.
Member Type, Function Acad.Promise.then Use this function to register callback.
Member Type, Function Acad.PromptAngleOptions This class represents optional parameters for an angle prompt.
Member Type, Function Acad.PromptCornerOptions This class represents optional parameters for a corner prompt.
Member Type, Function Acad.PromptDistanceOptions This class represents optional parameters for a distance prompt.
Member Type, Function Acad.PromptDoubleOptions This class represents optional parameters for a prompt for a double.
Member Type, Function Acad.PromptDoubleResult This class holds the result of a prompt, which returns a double as its primary result.
Member Type, Function Acad.PromptEditorOptions This is the base class for command prompt options used in various types of data acquisition.
Member Type, Function Acad.PromptEntityOptions This class represents optional parameters for an entity prompt. This function is derived from [Acad.PromptEditorOptions][].
Member Type, Function Acad.PromptEntityOptions.addAllowedClass Use this method to add type to the internal list of classes allowed for the selection.
Member Type, Function Acad.PromptEntityOptions.removeAllowedClass Use this method to remove the class indicated by type from the internal list of classes allowed for this selection.
Member Type, Function Acad.PromptEntityResult This class holds the result of a prompt that returns an entity as its primary result.
Member Type, Function Acad.PromptIntegerOptions This class represents optional parameters for a prompt for an integer.
Member Type, Function Acad.PromptIntegerResult This class holds the result of a prompt that returns an integer as its primary result.
Member Type, Function Acad.PromptKeywordOptions This class represents optional parameters for a prompt for a keyword.
Member Type, Function Acad.PromptNestedEntityOptions This class represents optional parameters for a prompt for a nested entity.
Member Type, Function Acad.PromptNestedEntityResult This class holds the result of a prompt that returns a nested entity as its primary result.
Member Type, Function Acad.PromptNumericalOptions This is the base class for types that represent optional parameters for numerical prompts.
Member Type, Function Acad.PromptOptions This is the base class for types that represent optional parameters for prompts.
Member Type, Function Acad.PromptOptions.setMessageAndKeywords Use this method to set the prompt message to the first part of the messageAndKeywords string and set the display keywords to the latter part of the same string.
Member Type, Function Acad.PromptPointOptions This class represents optional parameters for a point prompt.
Member Type, Function Acad.PromptPointResult This class holds the result of a prompt that returns a point as its primary result.
Member Type, Function Acad.PromptResults This is the base class for classes that hold the result of a prompt operation.
Member Type, Function Acad.PromptSelectionOptions This class provides optional parameters to a selection set prompt.
Member Type, Function Acad.PromptSelectionResult This class represents the result of a prompt for a selection of objects.
Member Type, Function Acad.PromptStatus This enum wraps the Acad::PromptStatus ObjectARX class.
Member Type, Function Acad.PromptStringOptions This class represents optional parameters for a prompt for string.
Member Type, Function Acad.Rectangle2d This class wraps the lowerLeft and upperRight Acad.Point2d objects.
Member Type, Function Acad.ResultValueType Use this enum to provide values that describe the value data type of a system variable.
Member Type, Function Acad.SelectedObject This is the base class for a selected object.
Member Type, Function Acad.SystemVariable This class represents system variables.
Member Type, Function Acad.SystemVariable.postValue Use this function to set system variable value using command.
Member Type, Function Acad.SystemVariableCollection This class represents system variable collection.
Member Type, Function Acad.SystemVariableCollection.addEventListener Use this function to add callback.
Member Type, Function Acad.SystemVariableCollection.getSystemVariable Use this function to return the system variable.
Member Type, Function Acad.SystemVariableCollection.parseSysVarValue Use this function to return the raw value of the system variable.
Member Type, Function Acad.SystemVariableCollection.removeEventListener Use this function to remove callback.
Member Type, Function Acad.TaskDialog.showDeleteConfirmationTaskDialog Shows a task dialog with a confirmation message to delete.
Member Type, Function Acad.TaskDialog.showTaskDialog Shows a custom task dialog.
Member Type, Function Acad.TaskDialogButton Use this enum to list the button that can be set for a task dialog.
Member Type, Function Acad.TaskDialogResult Use this enum to list the return result from a task dialog.
Member Type, Function Acad.Transient This is the controller object that is used to create and manage the transients.
Member Type, Function Acad.Transient.addEventListener Use this function to add a callback.
Member Type, Function Acad.Transient.getId Use this function to get the ID assigned to the transient object.
Member Type, Function Acad.Transient.removeEventListener Use this function to remove callback.
Member Type, Function Acad.TransientManager This is the controller object that is used to create and manage the transients.
Member Type, Function Acad.TransientManager.addTransient Use this function to add an Acad.Transient object to the AutoCAD transient manager.
Member Type, Function Acad.TransientManager.eraseTransient Use this function to erase the the Acad.Transient object from the AutoCAD transient Manager.
Member Type, Function Acad.TransientManager.eraseTransients Use this function to erase the the Acad.Transient objects from the AutoCAD transient Manager.
Member Type, Function Acad.TransientManager.getCursor Use this function to get the current cursor assigned to the Acad.Transient object.
Member Type, Function Acad.TransientManager.showTransients Use this function to show or hide the Acad.Transient objects in the AutoCAD transient manager.
Member Type, Function Acad.TransientManager.updateTransient Use this function to update an Acad.Transient object in the AutoCAD transient Manager.
Member Type, Function Acad.UserInputControls Use this enum for returning the bitwise OR'd value of all user input control settings in effect, at the present time, for a particular jig.
Member Type, Function Acad.Vector2d This class wraps the AcGeVector2d ObjectARX class. Vector2d represents a vector in 2D space. It can be viewed as a structure consisting of two doubles.
Member Type, Function Acad.Vector3d This class wraps the AcGeVector3d ObjectARX class. Vector3d represents a vector in 3D space. It can be viewed as a structure consisting of three doubles.
Member Type, Function Acad.ViewProperties Creates a container object which holds Viewport related properties.

Was this information helpful?