Solutions
Back
Online ViewerBuild a viewer that converts and displays models on a browser
Photo to 3DBuild an application to convert photos to 3D file
AEC Data Model (New)Enable granular access to AEC design data stored in the cloud
Autodesk Construction CloudIntegrate apps with the unified Autodesk Construction Cloud
Autodesk FormaGenerate geometry within Forma UI by using custom logic
Autodesk Fusion (New)Integrate and innovate with the Autodesk Fusion industry cloud
AutomationRun automation scripts for design and make
BIM 360Build apps and custom integrations for the construction industry
BuildingConnected API (New)Access BuildingConnected Pro and Bid Board Pro data
Data Exchange (New)Connect and access subsets of design data in your app of choice
Data ManagementAccess and manage files and data in Autodesk cloud storage
Data VisualizationVisualize heatmaps and sprites with custom data
Flow Graph Engine APICustom compute services for media & entertainment
Informed Design APIExtend and automate workflows from Informed Design
Manufacturing Data ModelRead, write, and extend manufacturing design data
Model DerivativeExtract data and convert file format of 2D or 3D models
Parameters APIStreamline data flows using the same parameters in any design tool
Reality CaptureCreate 3D models, orthophotos, and laser scans with photos
Tandem Data API (New)Enable read and write access to the Tandem database
Token FlexToken Flex customers: Access your token usage data
Vault Data APIsExtend Vault real-time data access
ViewerView and navigate through complex 2D and 3D models
WebhooksReceive event notifications from Autodesk Web Services
Getting Started
Documentation
Back
APIs & SDKs
Code Samples
Success Stories
Community
Back
Blog
Events
Accelerator
Lightning Talks
Solutions Showcase
Certified Partners
Developer Programs
DevCon 2025
Join Research Community
APS Roadmap
Data Roadmaps
Support
Back
API Status
Get Help
FAQ
Pricing
App Store
Back
Overview
Publisher Center
Publish Web App (Beta)
Publish Your App
Launch App Store

Request

Response

    UI

    Autodesk.Viewing.UI.Button

    Extends Control

    new Button(id,options)

    Button control that can be added to toolbars.

    Parameters

    Expand all
    id
    string
    		The ID for this button. Optional.
    options
    object
    		An optional dictionary of options.
    collapsible
    boolean
    		Whether this button is collapsible.

    Methods

    addClass(cssClass)

    Inherits addClass

    Adds a CSS class to this control.

    Parameters

    cssClass*
    string
    		The name of the CSS class.
    * Required

    getDimensions()

    Inherits getDimensions

    Returns the dimensions of this control.

    Returns

    TypeDescription
    object The width and height of the toolbar.

    getId()

    Inherits getId

    Gets this control’s ID.

    Returns

    TypeDescription
    string The control’s ID.

    getPosition()

    Inherits getPosition

    Returns the position of this control relative to the canvas.

    Returns

    TypeDescription
    object The top and left values of the toolbar.

    getState()

    Returns the state of this button.

    Returns

    TypeDescription
    State The state of the button.

    getToolTip()

    Inherits getToolTip

    Returns the tooltip text for this control.

    Returns

    TypeDescription
    string The tooltip text. Null if it’s not set.

    isCollapsed()

    Inherits isCollapsed

    Gets the collapsed state of this control.

    Returns

    TypeDescription
    boolean True if this control is collapsed.

    isCollapsible()

    Inherits isCollapsible

    Returns whether or not this control is collapsible.

    Returns

    TypeDescription
    boolean True if this control can be collapsed.

    isVisible()

    Inherits isVisible

    Gets the visibility of this control.

    Returns

    TypeDescription
    boolean True if the this control is visible.

    onClick(event)

    Override this method to be notified when the user clicks on the button.

    Parameters

    event*
    MouseEvent
    * Required

    onMouseOut(event)

    Override this method to be notified when the mouse leaves the button.

    Parameters

    event*
    MouseEvent
    * Required

    onMouseOver(event)

    Override this method to be notified when the mouse enters the button.

    Parameters

    event*
    MouseEvent
    * Required

    removeClass(cssClass)

    Inherits removeClass

    Removes a CSS class from this control.

    Parameters

    cssClass*
    string
    		The name of the CSS class.
    * Required

    setCollapsed(collapsed)

    Inherits setCollapsed

    Sets the collapsed state of this control.

    Parameters

    collapsed*
    boolean
    		The collapsed value to set.
    * Required

    Returns

    TypeDescription
    boolean True if the control’s collapsed state changes.

    setIcon(iconClass)

    Sets the icon for the button.

    Parameters

    iconClass*
    string
    		The CSS class defining the appearance of the button icon (e.g. image background).
    * Required

    setState(state)

    Sets the state of this button.

    Parameters

    state*
    State
    		The state.
    * Required

    Returns

    TypeDescription
    boolean True if the state was set successfully.

    setToolTip(toolTipText)

    Inherits setToolTip

    Sets the tooltip text for this control.

    Parameters

    toolTipText*
    string
    		The text for the tooltip.
    * Required

    Returns

    TypeDescription
    boolean True if the tooltip was successfully set.

    setVisible(visible)

    Inherits setVisible

    Sets the visibility of this control.

    Parameters

    visible*
    boolean
    		The visibility value to set.
    * Required

    Returns

    TypeDescription
    boolean True if the control’s visibility changed.

    Events

    COLLAPSED_CHANGED

    Event fired when the collapsed state of the control changes.

    Properties

    controlId
    string
    		The ID of the control that fired this event.
    isCollapsed
    boolean
    		True if the control is now collapsed.

    STATE_CHANGED

    Event fired when state of the button changes.

    Properties

    buttonId
    string
    		The ID of the button that fired this event.
    state
    State
    		The new state of the button.

    VISIBILITY_CHANGED

    Event fired when the visibility of the control changes.

    Properties

    controlId
    string
    		The ID of the control that fired this event.
    isVisible
    boolean
    		True if the control is now visible.
     
    ______
    icon-svg-close-thick

    Cookie preferences

    Your privacy is important to us and so is an optimal experience. To help us customize information and build applications, we collect data about your use of this site.

    May we collect and use your data?

    Learn more about the Third Party Services we use and our Privacy Statement.

    Strictly necessary – required for our site to work and to provide services to you

    These cookies allow us to record your preferences or login information, respond to your requests or fulfill items in your shopping cart.

    Improve your experience – allows us to show you what is relevant to you

    These cookies enable us to provide enhanced functionality and personalization. They may be set by us or by third party providers whose services we use to deliver information and experiences tailored to you. If you do not allow these cookies, some or all of these services may not be available for you.

    Customize your advertising – permits us to offer targeted advertising to you

    These cookies collect data about you based on your activities and interests in order to show you relevant ads and to track effectiveness. By collecting this data, the ads you see will be more tailored to your interests. If you do not allow these cookies, you will experience less targeted advertising.

    icon-svg-close-thick

    THIRD PARTY SERVICES

    Learn more about the Third-Party Services we use in each category, and how we use the data we collect from you online.

    icon-svg-hide-thick

    icon-svg-show-thick

    Strictly necessary – required for our site to work and to provide services to you

    Qualtrics
    W
    Akamai mPulse
    W
    Digital River
    W
    Dynatrace
    W
    Khoros
    W
    Launch Darkly
    W
    New Relic
    W
    Salesforce Live Agent
    W
    Wistia
    W
    Tealium
    W
    Upsellit
    W
    CJ Affiliates
    W
    Commission Factory
    W
    Google Analytics (Strictly Necessary)
    W
    Typepad Stats
    W
    Geo Targetly
    W
    SpeedCurve
    W
    Qualified
    #

    icon-svg-hide-thick

    icon-svg-show-thick

    Improve your experience – allows us to show you what is relevant to you

    Google Optimize
    W
    ClickTale
    W
    OneSignal
    W
    Optimizely
    W
    Amplitude
    W
    Snowplow
    W
    UserVoice
    W
    Clearbit
    #
    YouTube
    #

    icon-svg-hide-thick

    icon-svg-show-thick

    Customize your advertising – permits us to offer targeted advertising to you

    Adobe Analytics
    W
    Google Analytics (Web Analytics)
    W
    AdWords
    W
    Marketo
    W
    Doubleclick
    W
    HubSpot
    W
    Twitter
    W
    Facebook
    W
    LinkedIn
    W
    Yahoo! Japan
    W
    Naver
    W
    Quantcast
    W
    Call Tracking
    W
    Wunderkind
    W
    ADC Media
    W
    AgrantSEM
    W
    Bidtellect
    W
    Bing
    W
    G2Crowd
    W
    NMPI Display
    W
    VK
    W
    Adobe Target
    W
    Google Analytics (Advertising)
    W
    Trendkite
    W
    Hotjar
    W
    6 Sense
    W
    Terminus
    W
    StackAdapt
    W
    The Trade Desk
    W
    RollWorks
    W

    Are you sure you want a less customized experience?

    We can access your data only if you select "yes" for the categories on the previous screen. This lets us tailor our marketing so that it's more relevant for you. You can change your settings at any time by visiting our privacy statement

    Your experience. Your choice.

    We care about your privacy. The data we collect helps us understand how you use our products, what information you might be interested in, and what we can improve to make your engagement with Autodesk more rewarding.

    May we collect and use your data to tailor your experience?

    Explore the benefits of a customized experience by managing your privacy settings for this site or visit our Privacy Statement to learn more about your options.
    Version 5