व्हाइट लेबल स्मार्ट संपादक

ClippingMagic.js आपको अपनी वेबसाइट में Clipping Magic संपादक को आसानी से एकीकरण करने देता है। आप एकल इमेज जैसे फ्रंट पेज पर, या इकट्ठी क्लिपिंग जैसे इमेजेस अनुक्रम में, संपादित कर सकते हैं।

एकीकरण चरण

तेज़ी से शुरुआत को पहले पढ़ना याद रखें।

  1. सर्वर API का इस्तेमाल करके एक इमेज अपलोड करें।

  2. नीचे वर्णित अनुसार व्हाइट लेबल स्मार्ट संपादक को एम्बेड करें।

  3. आपके कोड द्वारा प्राप्त कॉलबैक पर प्रतिक्रिया करें क्योंकि आपका मानव ऑपरेटर इमेजिस को क्लिप करता है, जैस्रे कि अपने बैकएंड को नए उपलब्ध परिणामों को डाउनलोड करने का निर्देश देकर।

यह एकीकरण विकल्प आपको पूर्ण नियंत्रण प्रदान करता है, लेकिन इसके लिए एक गहरे फ्रंट-एंड एकीकरण की आवश्यकता होती है। अगर आपको आसान एकीकरण विकल्प की जरूरत है, तो कृपया होस्ट किए गए स्मार्ट संपादक को देखें।

सेटअप

ClippingMagic.js इस्तेमाल करने के लिए, इसे उन पेजेस पर शामिल और शुरू करके प्रारंभ करें जहाँ आप संपादन की अनुमति देना चाहते हों:

<script src="https://clippingmagic.com/api/v1/ClippingMagic.js" type="text/javascript"></script>
<script type="text/javascript">
  function myCallback(opts) {
    // TODO: Replace this with your own functionality
    switch (opts.event) {
      case "error":
          alert("An error occurred: " + opts.error.status + ", " + opts.error.code + ", " + opts.error.message);
          break;

      case "result-generated":
          alert("Generated a result for " + opts.image.id + ", " + opts.image.secret);
          break;

      case "editor-exit":
          alert("The editor dialog closed");
          break;
    }
  }
  var errorsArray = ClippingMagic.initialize({apiId: 123});
  if (errorsArray.length > 0) alert("Sorry, your browser is missing some required features: \n\n " + errorsArray.join("\n "));
</script>

एकल इमेज संपादित करें

आप निम्नलिखित तरीके से एकल इमेज के लिए संपादक प्रदर्शित कर सकते हैं:

ClippingMagic.edit({
    "image" : {
      "id" : 2345,
      "secret" : "image_secret"
    },
    "useStickySettings" : true,
    "locale" : "hi-IN"
  }, myCallback);

कॉलबैक फंक्शन को या तो result-generated या editor-exit से कॉल किया किया जाएगा, लेकिन दोनों से नहीं। प्रत्येक इंगित करता है कि संपादक बंद कर दिया गया है।

फैक्टरी डिफॉल्ट सेटिंग्स का इस्तेमाल करने के लिए useStickySettings के लिए false छोड़ें या पास इन करें।

चूंकि यह DOM के संदर्भ में है, इसलिए संबंधितदस्तावेज़ तैयार होने के ईवेंट के बाद कॉल किया जाना सुनिश्चित करें।


अनुक्रम में विविध इमेजेस संपादित करें

आप निम्नलिखित तरीके से बहुत-सी इमेजेस को संपादित करने के लिए संपादक प्रदर्शित कर सकते हैं:

ClippingMagic.edit({
    "images" : [ {
      "id" : 2345,
      "secret" : "image_secret"
    }, {
      "id" : 2346,
      "secret" : "image_secret2"
    } ],
    "useStickySettings" : true,
    "locale" : "hi-IN"
  }, myCallback);

उपयोगकर्ता द्वारा उत्पन्न प्रत्येक परिणाम के लिए कॉलबैक फंक्शन को result-generated के साथ एक बार कॉल किया जाएगा (= 'संपन्न' पर प्रत्येक क्लिक एक बार)। अंत में एक editor-exit कॉल होगी जो कि इंगित करेगी कि या तो उपयोगकर्ता द्वारा X क्लिक करने के कारण या संपादन के लिए इमेजेस समाप्त होने के कारण संपादक बंद हो गया है। जब उपयोगकर्ता किसी इमेज को छोड़ता है, तो कोई कॉलबैक नहीं होगा।

फैक्टरी डिफॉल्ट सेटिंग्स का इस्तेमाल करने के लिए useStickySettings के लिए false छोड़ें या पास इन करें।

चूंकि यह DOM के संदर्भ में है, इसलिए संबंधितदस्तावेज़ तैयार होने के ईवेंट के बाद कॉल किया जाना सुनिश्चित करें।


कॉलबैक function(opts)

edit फंक्शन callback फंक्शन को मापदंड के तौर पर लेता है। यह कॉलबैक आपको उपयोगकर्ता कार्रवाइयों का प्रत्युत्तर देने और इमेज संपादन प्रगति के बारे में आपके बैकएंड सर्वर को सूचित करने देता है।

कालबैक का सिग्नेचर function(opts) है और अपवाद और लौटाए गए मानों पर ध्यान नहीं दिया जाता। opts मापदंड PlainObject है जिसमें ये मौजूद है:

event

अभी-अभी क्या हुआ, यह इंगित करने वाली स्ट्रिंग्स, नीच दी गई तालिका देखें।

image वैकल्पिक। इमेज JSON ऑब्जेक्ट (केवल id और रहस्य शामिल है)।
error वैकल्पिक। एरर JSON ऑब्जेक्ट
ईवेंटइमेज है?एरर है?अर्थ
result-generatedहाँनहीं उपयोगकर्ता ने 'संपन्न' पर क्लिक कर दिया है, परिणाम सृजित किया गया है और बैकएंड API का इस्तेमाल करके तत्काल डाउनलोड के लिए उपलब्ध है। एकल-इमेज मोड में, संपादक बंद कर दिया गया है।
editor-exitनहींनहीं उपयोगकर्ता ने ऊपरी दाएं कोने में लाल X पर क्लिक करके संपादक बंद कर दिया है, या बहु-इमेज मोड में संपादित करने के लिए उपयोगकर्ता की इमेजेस समाप्त हो गई हैं। संपादक बंद कर दिया गया है।
errorनहींहाँ कोई एरर हुई है। अधिक जानकारी के लिए error मान का निरीक्षण करें। संपादक बंद कर दिया गया है।

जैसे ही संपादक बंद कर दिया जाता है आप फिर से edit() को कॉल कर सकते हैं (इससे पहले किए गए कॉल अपवाद की ओर ले जाते हैं)।

उदाहरण कॉलबैक आह्वान

callback({
  "event" : "result-generated",
  "image" : {
    "id" : 2345,
    "secret" : "image_secret"
  }
}); 

फंक्शन परिभाषाएं

ClippingMagic.initialize(opts) -> array_of_missing_features

initialize फंक्शन PlainObject वाले ऐसी कुंजी/मान वाले जोड़े लेता है जो कि प्रारंभ करने को कॉन्फिगर करते हैं:

apiId
आवश्यक
आपकी API Id।

यह फंक्शन स्ट्रिंग्स वाला जावास्क्रिप्ट ऐरे वापस करता है जिसमें ऐसी फीचर्स का वर्णन होता है जो मौजूदा ब्राउज़र में गायब हैं, परंतु संपादक को चलाने के लिए आवश्यक हैं। यदि यह ऐरे खाली है, तो आप आगे जा सकते हैं और edit फंक्शन को कॉल कर सकते हैं।

ClippingMagic.edit(opts, callback)

edit फंक्शन निम्नलिखित मापदंड लेता है:

opts

आवश्यक। PlainObject वाले कुंजी/मान जोड़े जो प्रारंभ करने को कॉन्फिगर करते हैं:

image

वैकल्पिक। इमेज JSON ऑब्जेक्ट (केवल id और सीक्रेट आवश्यक हैं).

images

वैकल्पिक। इमेज JSON ऑब्जेक्ट्स का ऐरे (केवल id और सीक्रेट आवश्यक हैं)।

useStickySettings

वैकल्पिक। Boolean, trueका अर्थ है कि API उपयोगकर्ता'की स्टिकी सेटिंग्स का इस्तेमाल किया जाएगा, false या छोड़ देने का अर्थ है कि फैक्टरी डिफॉल्ट्स का इस्तेमाल किया जाएगा।

यह आपको एक बार मूलभूत क्लिपिंग सेटिंग्स को कॉन्फिगर करने देता है, और फिर उन्हें आपके द्वारा संपादित सभी इमेजेस पर लागू करता है।

Read about how to configure the sticky settings

API के माध्यम से प्री-क्रॉप उपलब्ध नहीं है, परंतु आप API अपलोड कॉल में इमेज आकार सीमा कॉन्फिगर कर सकते हैं।

locale

वैकल्पिक। संपादक में इस्तेमाल करने के लिए लिए प्रदर्शन भाषा। यदि छोड़ा जाता है तो डिफॉल्ट रूप से अंग्रेज़ी होती है। मान्य मान निम्नलिखित हैं:

कोडप्रदर्शन भाषा
en-US English (अंग्रेज़ी)
de-DE Deutsch (जर्मन)
es-ES Español (स्पेनी)
fr-FR Français (फ़्रेंच)
hi-IN हिन्दी
id-ID Indonesia (इंडोनेशियाई)
it-IT Italiano (इतालवी)
ja-JP 日本語 (जापानी)
ko-KR 한국어 (कोरियाई)
pl-PL Polski (पोलिश)
pt-BR Português (पुर्तगाली)
ru-RU Русский (रूसी)
th-TH ไทย (थाई)
tr-TR Türkçe (तुर्की)
vi-VN Tiếng Việt (वियतनामी)
zh-Hans-CN 简体中文 (चीनी)
zh-Hant-TW 繁體中文 (चीनी)
callback

आवश्यक। विवरण के लिए ऊपर कॉलबैक सेक्शन देखें।

यह तरीका मान नहीं लौटाता है। यदि इस तरीके को कॉल करने से पहले initialize को कॉल नहीं किया गया है, या यदि initialize गैर-रिक्त ऐरे वापस लौटाता है, या संपादक विंडों पहले ही खुली हो, तब एक अपवाद दिया जाता है।