js-cloudimage-360-view
Advanced tools
[](https://github.com/scaleflex/js-cloudimage-360-view/releases) [](#contributing) [
Docs • Demo • Code Sandbox • Video Tutorial • Why
A simple, interactive resource that can be used to provide a virtual tour of your product.
To see the Cloudimage 360 view plugin in action, please check out the Demo page.
Add script tag with CDN link to js-cloudimage-360-view lib after all content in body tag
<script src="https://cdn.scaleflex.it/plugins/js-cloudimage-360-view/3.0.1/js-cloudimage-360-view.min.js"></script>
After adding the js-cloudimage-360-view lib, simply initialize it with class name "cloudimage-360", server folder path, file name and amount of images:
<div
class="cloudimage-360"
id="gurkha-suv"
data-folder="https://scaleflex.cloudimg.io/v7/demo/suv-orange-car-360/"
data-filename-x="orange-{index}.jpg"
data-amount-x="73"
></div>
Initialization of js cloudimage 360 view plugin.
window.CI360.init();
NOTE: initialization of the plugin runs on the script load. In case you need to postpone the initialization of the plugin you can disable it with notInitOnLoad param
<script>window.CI360 = { notInitOnLoad: true }</script> <script src="https://cdn.scaleflex.it/plugins/js-cloudimage-360-view/3.0./js-cloudimage-360-view.min.js"></script> <script>window.CI360.init(); // initialize the plugin when you need</script>
window.CI360.add(idOftheView: string);
lazy init cloudimage-360 view by id.
idOftheView: stringThe id of the new view
window.CI360.update(idOftheView, forceUpdate);
Update cloudimage 360 viewer instance.
For any update in source attributes after plugin initialization (e.g. data-folder, data-filename-x, data-amount-y),
the plugin will re-init.
idOftheView: stringThe id of the new view
forceUpdate: boolForce the view to reinitialize.
<div
class="cloudimage-360"
id="gurkha-suv"
data-folder="https://scaleflex.cloudimg.io/v7/demo/suv-orange-car-360/"
data-filename-x="orange-{index}.jpg"
data-amount-x="73"
></div>
window.CI360.update('gurkha-suv');
window.CI360.update(null, true);
Destroying a cloudimage 360 viewer instance will reset the HTML to its original state.
window.CI360.destroy();
Get the {index} of the image that is being viewed.
window.CI360.getActiveIndexByID(idOfInstance: string, oriantation: string);
idOfInstance: stringThe id of the instance
oriantation: stringThe oriantation of the active index
You can customize elements by adding the following classes:
.cloudimage-360-icons-container {
top: 5px;
right: 5px;
}
.cloudimage-360-fullscreen-modal {
top: 0;
bottom: 0;
}
.cloudimage-360-magnifier-icon {
background: url(https://scaleflex.ultrafast.io/https://scaleflex.airstore.io/filerobot/js-cloudimage-360-view/loupe.svg) 50% 50% / cover no-repeat;
}
.cloudimage-360-close-fullscreen-icon {
background: url(https://scaleflex.ultrafast.io/https://scaleflex.airstore.io/filerobot/js-cloudimage-360-view/cross.svg) 50% 50% / cover no-repeat;
}
.cloudimage-360-view-360-circle {
margin: auto;
}
.cloudimage-360-loader {
margin: auto;
}
.cloudimage-360-view-360-icon {
background: url(hhttps://scaleflex.ultrafast.io/https://scaleflex.airstore.io/filerobot/js-cloudimage-360-view/360_view.svg) 50% 50% / cover no-repeat;
}
.cloudimage-360-box-shadow {
top: 0;
left: 0;
}
.cloudimage-360-img-magnifier-glass {
border: 3px solid #000;
border-radius: 50%;
}
The selector for js-cloudimage-360-view lib.
Your images folder on server.
Allow to use a specific version of API.
data-api-version="v7"
data-api-version="null"
The filename pattern for your 360 image. Must include {index}, which the library will replace with a number between 1 and data-amount-x.
The same for data-amount-x but for images set in Y-axis.
Amount of images to load in X-axis for 360 view .
Amount of images to load in Y-axis for 360 view.
Support for 360 spin by pressing arrow keys on keyboard.
invert arrow keys on keyboard.
Autoplay 360 spin view on load.
stops the autoplay after one complete cycle.
Changing autoplay behavior
Available behaviors (spin-x, spin-y, spin-xy, spin-yx)
Open 360 spin view in full screen modal.
Magnifier to zoom image.
ratio: stringSetting the height relative to the container width according to the provided ratio
<div
class="cloudimage-360"
id="gurkha-suv"
data-folder="https://scaleflex.cloudimg.io/v7/demo/suv-orange-car-360/"
data-filename-x="orange-{index}.jpg"
data-amount-x="73"
data-ratio="2"
></div>
ratio: JSONSetting the height relative to the container width at any window size.
In the following example, the height should be 1.3 the container width at window size less than or equal to 567px and 2.22 at window size less than or equal to 768px.
<div
class="cloudimage-360"
id="gurkha-suv"
data-folder="https://scaleflex.cloudimg.io/v7/demo/suv-orange-car-360/"
data-filename-x="orange-{index}.jpg"
data-amount-x="73"
data-ratio='{
"576": "1.3",
"768": "2.22",
"992": "2.23",
"1200": "3",
"2400": "3.2"
}'
></div>
Autoplay 360 spin view on load.
disable mouse drag.
Speed of changing frames for autoplay in milliseconds.
Speed Factor of changing frames on drag event.
Spin direction, by default it uses counterclockwise (image indexes from 1 to data-amount-x).
Apply box shadow for container.
Display 360 view line at the bottom of container.
Hide 360 view icon.
Spin direction using controls, by default it uses counterclockwise (image indexes from 1 to data-amount-x).
Blocks repeating images after reaching last image (or first image in opposite direction)
Bottom offset for 360 view line.
Left zero padding on filename. For example: index-zero-base="4" => image index will be "0004"
Option to add list of images in x-oriantation instead of folder , filename-x & amount-x.
example:
data-folder="https://scaleflex.airstore.io/demo/360-car/"
data-image-list-x='[
"iris-1.jpeg",
"iris-4.jpeg",
"https://scaleflex.airstore.io/demo/360-car/iris-12.jpeg",
"https://scaleflex.airstore.io/demo/360-car/iris-15.jpeg"
]’
Option to add list of images in y-oriantation instead of folder , filename-y & amount-y.
example:
data-folder="https://scaleflex.airstore.io/demo/360-car/"
data-image-list-y='[
"iris-2-y.jpeg",
"iris-6-y.jpeg",
"https://scaleflex.airstore.io/demo/360-car/iris-8-y.jpeg",
"https://scaleflex.airstore.io/demo/360-car/iris-30-y.jpeg"
]’
Option to scale images on click on it to provided value.
example:
data-pointer-zoom="3"
Only 360 view images close to the client's viewport will be loaded, hence accelerating the page loading time. If set to true, an additional script must be included, see Lazy loading
Helper class to apply lazy-loading depending on library you choose, see Lazy loading
You can add controls by adding elements with the following classes: cloudimage-360-left, cloudimage-360-right, cloudimage-360-top, **cloudimage-360-bottom
.cloudimage-360 .cloudimage-360-left, .cloudimage-360 .cloudimage-360-right {
padding: 8px;
background: rgba(255, 255, 255, 0.5);
border: none;
border-radius: 4px;
}
.cloudimage-360 .cloudimage-360-left:focus, .cloudimage-360 .cloudimage-360-right:focus {
outline: none;
}
.cloudimage-360 .cloudimage-360-left {
display: none;
position: absolute;
z-index: 100;
top: calc(50% - 15px);
left: 20px;
}
.cloudimage-360 .cloudimage-360-right {
display: none;
position: absolute;
z-index: 100;
top: calc(50% - 15px);
right: 20px;
}
.cloudimage-360 .cloudimage-360-left:before, .cloudimage-360 .cloudimage-360-right:before {
content: '';
display: block;
width: 30px;
height: 30px;
background: 50% 50% / cover no-repeat;
}
.cloudimage-360 .cloudimage-360-left:before {
background-image: url('https://cdn.scaleflex.it/plugins/js-cloudimage-360-view/assets/img/arrow-left.svg');
}
.cloudimage-360 .cloudimage-360-right:before {
background-image: url('https://cdn.scaleflex.it/plugins/js-cloudimage-360-view/assets/img/arrow-right.svg');
}
.cloudimage-360 .cloudimage-360-left.not-active, .cloudimage-360 .cloudimage-360-right.not-active {
opacity: 0.4;
cursor: default;
}
<div
class="cloudimage-360"
data-folder="https://scaleflex.airstore.io/demo/indoor/"
data-filename-x="{index}.jpeg"
>
<button class="cloudimage-360-left"></button>
<button class="cloudimage-360-right"></button>
<button class="cloudimage-360-top"></button>
<button class="cloudimage-360-bottom"></button>
</div>
Display information about the product on specific areas. Once a hotspot is created it can be used on more than one image.
First, we need to set data-hotspots attribute to the view we want to add hotspots or markers on it, to prevent the plugin to init the view without hotspots config.
Also we need to set an id attribute, we will need it to link the view with the hotspots config.
The hotspots config should be an array of objects, each object in the array indicates a single hotspot config.
For each item in the array, we need to set the positions (X-coord and Y-coord) of the hotspot at every image index we need to show the hotspot on it.
hint: To know the current image index we will need to set data-info="white || black" attribute.
example:
const HOTSPOTS_CONFIG = [
{
positions: [
{ imageIndex: 0, xCoord: 527, yCoord: 319 },
{ imageIndex: 1, xCoord: 524 },
{ imageIndex: 2, xCoord: 520 },
{ imageIndex: 3, xCoord: 498 },
{ imageIndex: 4, xCoord: 470 },
{ imageIndex: 5, xCoord: 441 },
]
}
]
In the previous example, we have only set the Ycoord a single time at the image index 0. So if the coord didn't change there's no need to reset it, it will already take the previous value.
Now we need to set the hotspot variant, we have three types of hotspots (link, popup, and custom), as it will be explained below.
we need to provide the URL of the link and the link title.
example:
const HOTSPOTS_CONFIG = [
{
positions,
variant: {
title: 'New Gurkha Technical Specifications',
url: 'https://www.forcegurkha.co.in/specifications/',
newTab: true
}
}
]
Only the property inserted will displayed.
| Property | Type | Default | Description |
|---|---|---|---|
| images | Array | [] | To display a carousel of images we need an array of objects, each object should include the src and the alt of each image |
| title | String | null | Display title underneath the images |
| description | String | null | Display description underneath the title |
| moreDetailsUrl | String | null | Display a button underneath the description to navigate to a provided URL |
| moreDetailsTitle | String | null | Set the title of the more details button |
example:
const HOTSPOTS_CONFIG = [
{
positions,
variant: {
images: [
{ src: 'https://scaleflex.cloudimg.io/v7/demo/360-assets/AIR_SNORKEL_FINAL_JPG.png?vh=88bccb', alt: 'air snorkel' }
], // optional
title: 'Air Intake Snorkel', // optional
description: 'The snorkel gives the Gurkha an unmatched water-wading ability and ensures ample supply of fresh air for combustion.', // optional
moreDetailsUrl: 'https://forcegurkha.co.in', // optional
moreDetailsTitle: 'Read more' // optional
}
}
]
Display any element in the DOM in a popup and link it with the hotspot.
We will need to set the variant property value to the id of the element.
example:
const HOTSPOTS_CONFIG = [
{
positions,
variant: 'gurkha-suv'
}
]
Options to customize the hotspot popup.
| Property | Type | Defaullt | Description |
|---|---|---|---|
| popupSelector | String | null | Set className to the popup wrapper |
| open | Boolean | false | Open the popup |
| arrow | Boolean | true | Dipslay an arrow that points toward the hotspot element |
| offset | Array | [0, 0] | Set a distance between the hotspot element and the popup |
| placement | String | Auto | - we can adjust the position of the hotspot popup relative to the hotspot element. (top - bottom - left - right) |
example:
const HOTSPOTS_CONFIG = [
{
positions,
variant,
popupProps: {
popupSelector: 'air-intake-popup', // optional
offset: [20, 5], // optional
arrow: false, // optional
placement: 'bottom' // optional
},
indicatorSelector: 'first-hotspot-icon' // optional
}
]
Now we need to make our hotspots responsive to have an accurate positioning in different screens.
we have to set initialDimensions property to every hotspot config. which indicates the dimension of the cloudimage-360 view.
hint: data-info can be used to get view size.
example:
const HOTSPOTS_CONFIG = [
{
positions,
variant,
popupProps,
indicatorSelector,
initialDimensions: [ 1170, 662 ]
}
]
we need this function to link the created config with the 360-view.
window.CI360.addHotspots(idOftheView, hotspotsConfig);
example:
window.CI360.addHotspots("gurkha-suv", HOTSPOTS_CONFIG);
Enables cloudimage responsive plugin for 360 view.
See how it works (article on Medium)
To use the Cloudimage Responsive plugin, you will need a Cloudimage token to deliver your images over CDN. Don't worry, it only takes seconds to get one by registering here. Once your token is created, you can configure it as described below. This token allows you to use 25GB of image cache and 25GB of worldwide CDN traffic per month for free.
Enables cloudimage responsive plugin for 360 view.
Applies Cloudimage resize operations to your image, e.g. width, height, crop, face crop, rotate, prevent enlargement...
Multiple transformation operations can be applied to your image, separated by "&" (Ampersand).
example:
data-transformation="w=400&h=200&func=fit"
Applies Cloudimage filters to your image, e.g. brightness, contrast, greyscale, blur, Sharpen...
Multiple filters can be applied, separated by "," (comma).
example:
data-filters="bright:15,contrast:30"
Lazy loading is not included into js-cloudimage-360-view by default. There are well thought libraries to achieve that. If you enable lazy loading in the configuration, you need to add an additional library like lazysizes, yall.js (Yet Another Lazy Loader), lozad.js to handle it.
Implementation example with lazysizes
Implementation example with yall.js
Implementation example with lozad.js
Tested in all modern browsers and IE 11, 10, 9.
All contributions are super welcome!
JS Cloudimage 360 View is provided under the MIT License
3.0.1 - 2022-03-28
FAQs
<h1 a
The npm package js-cloudimage-360-view receives a total of 497 weekly downloads. As such, js-cloudimage-360-view popularity was classified as not popular.
We found that js-cloudimage-360-view demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.