` element to the method `bindConfigurator`.\nSubscribe to the event `loaded` and you will know when your configurator is loaded.\n\nThis element supports the following methods:\n\n| Method | Params | Description |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |\n| `changeFrame` |
- `frame` *(string), named frame defined in the \"view-position\" format. Eg.: \"side-0\"*
- `options` *(JSON object with optional fields)*: `duration`: *(number)* total duration, in milliseconds, of the animation; `type`: *(string)* the animation style you want, which can be \"simple\" (fade in), \"cross\" (crossfade) or null (without any style)*; `preventDrag`: *(boolean)* to choose if drag actions during an animated change of frames should be ignored. \"True\" by default
| Displays a new frame, with an animation from the starting frame. |\n| `highlight` |
- `part` *(string), named part*
- `options` *(JSON object with optional fields)*
| Highlights a product's part. |\n| `lowlight` |
- `options` *(JSON object with optional fields)*
| Removes any highlight from the product. |\n| `selectPart` |
- `part` *(string), named part*
- `options` *(JSON object with optional fields)*
| Selects a given product's part. |\n| `deselectPart` |
- `part` *(string), named part*
- `options` *(JSON object with optional fields)*
| Removes selection from a given product's part. |\n\nThis element supports the following events:\n\n| Event | Description |\n| --------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| `ready` | Triggered upon first loading of the model's internal frame structure (once per model load). |\n| `loaded` | Triggered when the configurator finishes loading all of the internal frames, and is ready for interaction (once per part setting). |\n| `changed_frame` | Raises whenever there's a rotation in the configurator viewport (viewable frame has changed). |\n\n```javascript\nvar element = document.getElementById(\"config\");\nvar configurator = ripe.bindConfigurator(element, {});\n\nconfigurator.bind(\"loaded\", function() {\n this.changeFrame(\"side-11\", {\n duration: 500\n });\n});\n```\n\n## 7. Plugins\n\n### Part synchronization\n\nIf your product has synchronization rules, where a set of parts must always have the same material and color, you can use the `sync` plugin to have this behavior automatically. To do this you need to initialize the `SyncPlugin` which receives the synchronization rules and add it to the ripe object using the `addPlugin` function. When a new part is set, the plugin checks the synchronization rules and automatically makes the necessary changes to the related parts.\n\n```javascript\nripe.getConfig(function(config) {\n var syncRules = config.sync;\n var syncPlugin = new Ripe.plugins.SyncPlugin(syncRules);\n ripe.addPlugin(syncPlugin);\n});\n```\n\n### Part restrictions\n\nTo include restrictions to the customization experience the `Restrictions` plugin is available. This allow setting rules that declare that certain combinations between different parts, materials or colors are not possible. When a new option is selected, the plugin will check if any of the other parts has become restricted by the new part and change them to a valid option automatically. The usage of this plugin is similar to the `sync` plugin.\nTo be notified when a restriction causes parts to be changed, bind to the `restrictions` event on the plugin object. Whenever the restrictions are applied, this event will be triggered with the changes that ocurred and the part that caused them.\n\n```javascript\nripe.getConfig(function(config) {\n var restrictionRules = config.restrictions;\n var restrictionsPlugin = new Ripe.plugins.RestrictionsPlugin(restrictionRules);\n ripe.addPlugin(restrictionsPlugin);\n restrictionsPlugin.bind(\"restrictions\", function(changes, part) {});\n});\n```\n\n## 8. Sizes\n\nIf you need to create an order using the `ripe-core` API then you have to set the size of the product according to the `ripe-core` native scale. The following methods allow you to convert from and to that scale. `scale` is a string that represents the size scale, `value` is the numeric value in that scale and `gender` is a string that can be set to `female`, `male` or `kids`.\nTo reduce the number of requests when you need to convert several size options you can use the bulk methods that accept an array of values and return an array with all the results.\n\n* `sizeToNative(scale, value, gender)`\n* `nativeToSize(scale, value, gender)`\n* `sizeToNativeB(scales, values, genders)`\n* `nativeToSizeB(scales, values, genders)`\n\n## 9. Authentication\n\nWhen using API methods that require special permissions you can use the following methods to authenticate your application: `auth(username, password, callback)`, for login with username and password, or OAuth authentication with `oauth`:\n\n```javascript\nif (ripe.isOAuthPending()) {\n ripe.oauth({\n clientId: clientId,\n clientSecret: clientSecret,\n scope: [\"admin\"]\n });\n}\n```\n\n## Appendix\n\n### Options\n\n| Name | Type | Description |\n| ------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `backgroundColor` | *string* | RGB format color value of the background ( no need to pass the \"#\" signal ). No background by default. Example: \"cccccc\". |\n| `country` | *string* | Two letters standard country codes defined in *ISO 3166-1 alpha-2* codes. \"US\" by default. Example: \"PT\". |\n| `currency` | *string* | Standard currency codes defined in *ISO 4217* codes. \"USD\" by default. Example: \"EUR\". |\n| `frames` | *array of strings* | All the frames to be used in the customization. Example: [\"top\", \"bottom\", \"1\", \"2\"]. |\n| `format` | *string* | One of the valid image formats: 'lossless', 'lossful', 'jpeg', 'webp', 'sgi' or 'png'. \"null\" by default. |\n| `maskDuration` | *number* | Specifies how many milliseconds the mask animation takes to complete. 150 by default. |\n| `maskOpacity` | *number* | Specifies the opacity value of the the masks used to highlight/select parts. 0.4 by default. |\n| `maxSize` | *number* | Maximum value for frame image size. 1000px by default. |\n| `noCombinations` | *boolean* | Defines if the combinations are loaded or not. False (loading) by default. |\n| `noDefaults` | *boolean* | Defines if the defaults are loaded or not. False (loading) by default. |\n| `noMasks` | *boolean* | Used to negate the `useMasks` option. |\n| `noPrice` | *boolean* | Used to negate the `usePrice` option. |\n| `parts` | *JSON Object* | Defines the product initial parts. Each key is a part's name built with color and material information. Example: `var parts = { \"sole\": { \"material\": \"nappa\", \"color\": \"white\" }, ... }`. |\n| `remoteCalls` | *boolean* | Activates the remote calls functionality executed by several workflows. True by default. |\n| `remoteOnConfig` | *boolean* | Activates the remote execution of the model's logic on config updates. True by default. |\n| `remoteOnPart` | *boolean* | Activates the remote execution of the model's logic on parts updates. True by default. |\n| `remoteOnInitials` | *boolean* | Activates the remote execution of the model's logic on initials updates. True by default. |\n| `sensitivity` | *string* | Defines the degree of sensitivity of the dragging interaction. 40 by default. |\n| `size` | *number* | Initial size value of a frame image that is going to be composed. By default it's 1000px. |\n| `url` | *string* | The base `url` of the server where the product is configured. |\n| `variant` | *string* | Variant of the customizable product. |\n| `version` | *string* | The version of the build of the customizable product. |\n| `useChain` | *boolean* | Determines if a chain based loading should be used for the pre-loading process of the various image resources to be loaded. False by default. |\n| `useMasks` | *boolean* | Enables masks on selection/highlight. True by default. |\n| `usePrice` | *boolean* | Enables the fetch price feature every time a new part is set. True by default. |\n| `useSync` | *boolean* | Enables the part synchronization feature. False by default. |\n| `useInitialsBuilderLogic` | *boolean* | Enables the usage of the client-side initials builder logic defined in the 3DB, instead of the default one. True by default. |\n\n## Browser Support\n\nDesktop:\n\n* ≥ Chrome v23 (V8)\n* ≥ Firefox v21 (SpiderMonkey)\n* ≥ Safari v6 (Nitro)\n* ≥ Opera v12 (V8)\n* ≥ IE v11 (Chakra)\n\nMobile:\n\n* ≥ Android 4.4\n* ≥ iOS's WebKit 9\n\n## Documentation\n\nFor API reference documentation follow [ripe-sdk-docs.platforme.com](https://ripe-sdk-docs.platforme.com).\n\n## License\n\nRIPE SDK is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).\n\n## Build Automation\n\n[](https://travis-ci.com/github/ripe-tech/ripe-sdk)\n[](https://github.com/ripe-tech/ripe-sdk/actions)\n[](https://www.npmjs.com/package/ripe-sdk)\n[](https://www.apache.org/licenses/)\n","readmeFilename":"README.md"}
![\"RIPE](\"res/logo.svg\"){kind=logo}