Blokada klasy
Zajęcia obejmujące jeden blok. Zwykle nie jest wywoływany bezpośrednio, preferowane jest workspace.newBlock().
Podpis:
export declare class Block
Zespoły
| Zespół | Modyfikatory | Opis |
|---|---|---|
| (constructor)(workspace, prototypeName, opt_id) | Tworzy nową instancję klasy Block. |
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| childBlocks_ | protected |
this[] | |
| collapsed_ | protected |
wartość logiczna | |
| COLLAPSED_FIELD_NAME |
|
ciąg znaków | Identyfikator niezależny od języka nadany zwężonemu polu. |
| COLLAPSED_INPUT_NAME |
|
ciąg znaków | Identyfikator niezależny od języka nadany zwężonemu wejściu. |
| colour_ | protected |
ciąg znaków | Kolor bloku w formacie #RRGGBB. |
| compose? | (rootBlock: Block) => void | (Opcjonalnie) Opcjonalna metoda, która zmienia konfigurację blokady na podstawie zawartości okna mutatora. | |
| contextMenu | wartość logiczna | ||
| data | string | null | Opcjonalne dane tekstowe, które są przesyłane między blokami a XML. Nie ma żadnego efektu. Mogą być używane przez osoby trzecie do celów związanych z metainformacjami. | |
| decompose? | (workspace: Workspace) => Zablokuj | (Opcjonalnie) Opcjonalna funkcja, która wypełnia menu rozwijane modułu mutatora blokami reprezentującymi konfigurację tego bloku. | |
| destroy? | () => void | (Opcjonalnie) opcjonalna metoda wywoływana podczas usuwania. | |
| disposing | protected |
wartość logiczna | Czy bieżący blok jest obecnie w trakcie usuwania? |
| domToMutation? | (p1: Element) => void | (Opcjonalnie) Opcjonalna metoda deserializacji określająca, jak zdeserializować stan mutacji z pliku XML. Musi być ona połączona z definicją mutationToDom. |
|
| getDeveloperVariables? | () => string[] | (Opcjonalnie) Opcjonalna metoda deklarowania zmiennych programisty, która ma być używana przez generatory. Zmienne dewelopera nigdy nie są widoczne dla użytkownika, ale są deklarowane jako zmienne globalne w wygenerowanym kodzie. | |
| czapka? | ciąg znaków | (Opcjonalnie) Nazwa typu kapelusza. | |
| helpUrl | string | (() => string) | null | Ciąg znaków dla pomocy blokowania lub funkcja zwracająca adres URL. Brak pomocy. | |
| ikony | IIcon[] | ||
| id | ciąg znaków | ||
| init? | () => void | (Opcjonalnie) Opcjonalna metoda wywoływana podczas inicjalizacji. | |
| inputList | Dane wejściowe[] | ||
| inputsInline? | wartość logiczna | (Opcjonalnie) | |
| inputsInlineDefault? | wartość logiczna | (Opcjonalnie) | |
| isInFlyout | wartość logiczna | ||
| isInMutator | wartość logiczna | ||
| isInsertionMarker_ | protected |
wartość logiczna | Wartość Prawda, jeśli ten blok jest znacznikiem wstawiania. |
| loadExtraState? | (p1: any) => void | (Opcjonalnie) Opcjonalna metoda serializacji służąca do zdefiniowania sposobu deserializacji dodatkowego stanu bloku (np. stanu mutacji) z czegoś zgodnego z formatem JSON. Musi być ona połączona z definicją saveExtraState. |
|
| mutationToDom? | (...p1: any[]) => Element | (Opcjonalnie) Opcjonalna metoda serializacji określająca sposób serializacji stanu mutacji do formatu XML. Musi być ona połączona z definicją domToMutation. |
|
| nextConnection | Połączenie | null | ||
| onchange? | ((p1: Abstract) => void) | null | (Opcjonalnie) Opcjonalna metoda wywołania zwrotnego, która jest używana, gdy zmienia się nadrzędny obszar roboczy bloku. Zwykle jest on wywoływany tylko z konstruktora, funkcji inicjalizatora typu bloku lub funkcji inicjalizatora rozszerzenia. | |
| outputConnection | Połączenie | null | ||
| outputShape_ | protected |
number | null | |
| parentBlock_ | protected |
this | null | |
| previousConnection | Połączenie | null | ||
| renderowany | readonly |
wartość logiczna | Czy ten blok jest blokiem SVG? |
| RTL | wartość logiczna | ||
| saveExtraState? | (doFullSerialization?: boolean) => any | (Opcjonalnie) Opcjonalna metoda serializacji służąca do zdefiniowania sposobu serializacji dodatkowego stanu bloku (np. stanu mutacji) w postaci danych zgodnych z formatem JSON. Musi być to połączone z zdefiniowaniem loadExtraState. |
|
| styleName_ | protected |
ciąg znaków | Nazwa stylu bloku. |
| suppressPrefixSuffix | boolean | null | Opcjonalna właściwość do pomijania dodawania STATEMENT_PREFIX i STATEMENT_SUFFIX do wygenerowanego kodu. | |
| etykieta | Tooltip.TipInfo | ||
| type | ciąg znaków | ||
| workspace | Workspace |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| addIcon(icon) | Dodaje daną ikonę do bloku. | |
| allInputsFilled(opt_shadowBlocksAreFilled) | Sprawdza rekurencyjnie, czy wszystkie dane instrukcji i wartości są wypełnione blokami. Sprawdza też wszystkie kolejne bloki instrukcji w tym stosie. | |
| appendDummyInput(name) | Dodaje pusty wiersz danych wejściowych. | |
| appendEndRowInput(name) | Dodaje dane, które kończą wiersz. | |
| appendInput(input) | Dodaje podany wiersz danych wejściowych. Umożliwia dołączanie niestandardowych danych wejściowych do bloku. |
|
| appendStatementInput(name) | Dodaje wiersz danych wejściowych oświadczenia. | |
| appendValueInput(name) | Dodaje wiersz z wartością wejściową. | |
| bumpNeighbours() | przesuwać niespójnych bloków poza obszar dopasowania. Dwa bloki, które nie są ze sobą połączone, nie powinny przypadkowo ustawiać się w ten sam sposób na ekranie. | |
| dispose(healStack) | Usuń ten blok. | |
| disposeInternal() | protected |
Odrzuca ten blok bez wykonywania czynności wymaganych przez blok wyższy. np. nie uruchamia zdarzeń, nie odłącza blokady itp. |
| doInit_() | protected |
Wywołuje funkcję init() i obsługuje powiązane zdarzenia. |
| getChildren(ordered) | Znajdź wszystkie bloki bezpośrednio zagnieżdżone w tym bloku. Obejmuje wartości i dane wejściowe instrukcji, a także wszystkie kolejne instrukcje. Wyklucza wszystkie połączenia na karcie Wyjście lub w poprzednich instrukcjach. Bloki są opcjonalnie sortowane według pozycji od góry do dołu. | |
| getColour() | Pobierz kolor bloku. | |
| getCommentText() | Zwraca komentarz do tego bloku (lub wartość null, jeśli nie ma komentarza). | |
| getDescendants(ordered) | Znajdź wszystkie bloki, które są bezpośrednio lub pośrednio zagnieżdżone w tym bloku. Uwzględnia ten blok na liście. Obejmuje wartości i dane wejściowe instrukcji, a także wszystkie kolejne instrukcje. Wyklucza wszystkie połączenia na karcie danych wyjściowych i wszystkie poprzednie instrukcje. Bloki są opcjonalnie sortowane według pozycji od góry do dołu. | |
| getDisabledReasons() | Uzyskaj zestaw powodów, dla których blokada jest obecnie wyłączona (jeśli występuje). Jeśli blokowanie jest włączone, ten zestaw będzie pusty. | |
| getField(name) | Zwraca pole o nazwie z bloku. | |
| getFields() | Zwraca generator, który udostępnia wszystkie pola bloku. Generator, którego można użyć do iteracji pól w bloku. |
|
| getFieldValue(name) | Zwraca wartość danego pola neutralną pod względem języka. | |
| getHue() | Pobierz wartość odcienia HSV bloku. Wartość null, jeśli odcień nie jest ustawiony. | |
| getIcon(type) | ||
| getIcons() | ||
| getInheritedDisabled() | Uzyskaj informacje o tym, czy blokada jest wyłączona z powodu rodziców. Własna wyłączona właściwość bloku nie jest brana pod uwagę. | |
| getInput(name) | Pobiera nazwany obiekt wejściowy. | |
| getInputsInline() | Określ, czy wartości wejściowe są ułożone poziomo czy pionowo. | |
| getInputTargetBlock(name) | Pobiera blok dołączony do nazwanego wejścia. | |
| getInputWithBlock(block) | Zwraca dane wejściowe, które łączą się z określonym blokiem. | |
| getNextBlock() | Zwróć następny blok instrukcji bezpośrednio połączony z tym blokiem. | |
| getOutputShape() | Pobierz kształt wyjściowy bloku. | |
| getParent() | Zwraca blok nadrzędny lub null, jeśli ten blok znajduje się na najwyższym poziomie. Blok nadrzędny to blok połączony z poprzednim połączeniem (w przypadku bloku instrukcji) lub blok połączony z połączeniem wyjściowym (w przypadku bloku wartości). | |
| getPreviousBlock() | Zwraca blok połączony z poprzednim połączeniem. | |
| getRelativeToSurfaceXY() | Zwraca współrzędne lewego górnego rogu tego bloku względem punktu początkowego (0,0) na powierzchni rysunku w jednostkach obszaru roboczego. | |
| getRootBlock() | Zwraca blok znajdujący się na szczycie drzewa tego bloku. Jeśli blok znajduje się na najwyższym poziomie, zwróci sam siebie. | |
| getStyleName() | Pobierz nazwę stylu bloku. | |
| getSurroundParent() | Zwraca blok nadrzędny otaczający bieżący blok lub wartość null, jeśli ten blok nie ma bloku otaczającego. Blok nadrzędny może być po prostu poprzednim instrukcją, a blok otaczający może być instrukcją if, pętlą while itp. | |
| getTooltip() | Zwraca tekst opisu tego bloku. | |
| getVars() | Zwraca wszystkie zmienne, do których odwołuje się ten blok. | |
| hasDisabledReason(reason) | Określ, czy blokada jest obecnie wyłączona z podanego powodu. | |
| hasIcon(type) | ||
| initModel() | Wywołaj initModel we wszystkich polach bloku. Może być wywoływany więcej niż raz. Po utworzeniu bloku i przed pierwszą interakcją z nim należy wywołać initModel lub initSvg. Interakcje obejmują działania w interfejsie (np. klikanie i przeciąganie) oraz uruchamianie zdarzeń (np. tworzenie, usuwanie i zmienianie). | |
| isCollapsed() | Wskazuje, czy blokada jest zwinięta. | |
| isDeletable() | Określ, czy blokada może zostać usunięta. | |
| isDisposed() | Zwraca informację o tym, czy ten blok został usunięty. | |
| isDuplicatable() | Określ, czy blokada może być powielana. Jeśli zduplikowanie tego bloku i jego potomków spowoduje przekroczenie limitu miejsca w roboczym, bloku nie można powielać. Jeśli duplikowanie tego bloku i jego potomków spowoduje, że dowolny typ przekroczy wartość maxInstances, blok nie będzie można powielać. | |
| isEnabled() | Określ, czy blokada jest włączona. Blokada jest włączona, jeśli nie ma żadnych powodów, dla których miałaby być wyłączona. Blokada może być nadal wyłączona z innych powodów, nawet jeśli użytkownik spróbuje ją ręcznie włączyć, np. gdy blokada znajduje się w nieprawidłowej lokalizacji. | |
| isInsertionMarker() | Określa, czy blok jest blokiem znacznika wstawienia. | |
| isOwnDeletable() | Zwraca wartość wskazującą, czy własność deletable tego bloku ma wartość true (prawda) czy false (fałsz). | |
| isOwnEditable() | Zwraca wartość „prawda” lub „fałsz” własności tego bloku, która może być edytowana. | |
| isShadow() | Określ, czy blokada jest blokadą cienia. | |
| jsonInit(json) | Inicjuj ten blok za pomocą wieloplatformowego opisu w formacie JSON z uwzględnieniem ujednolicania. | |
| mixin(mixinObj, opt_disableCheck) | Dodaj klucze/wartości z obiektu mixinObj do tego obiektu bloku. Domyślnie ta metoda sprawdza, czy klucze w mixinObj nie zastąpią istniejących wartości w bloku, w tym wartości prototypu. Zapewnia to pewną ochronę przed niezgodnością miksów i rozszerzeń z przyszłymi funkcjami bloków. Można wyłączyć tę kontrolę, podając wartość true jako drugi argument. | |
| moveBy(dx, dy, reason) | Przesuń blok o współrzędną względną. | |
| moveInputBefore(name, refName) | Przesuń nazwany element wejściowy w inne miejsce w tym bloku. | |
| moveNumberedInputBefore(inputIndex, refIndex) | Przesuń pole numeryczne w inne miejsce w tym bloku. | |
| removeIcon(type) | Usuwa z bloku ikonę, której właściwość getType odpowiada podanemu parametrowi iconType. | |
| removeInput(name, opt_quiet) | Usuń dane wejściowe z tego bloku. | |
| renameVarById(oldId, newId) | Powiadomienie o zmianie nazwy zmiennej. Jeśli identyfikator pasuje do jednej z zmiennych tego bloku, zmień jego nazwę. | |
| setCollapsed(collapsed) | Określ, czy blok jest zwinięty. | |
| setColour(colour) | Zmień kolor bloku. | |
| setCommentText(text) | Ustaw tekst komentarza do tego bloku. | |
| setDeletable(deletable) | Określ, czy blokada ma być możliwa do usunięcia. | |
| setDisabledReason(disabled, reason) | Dodaj lub usuń powód, dla którego blokada może zostać wyłączona. Jeśli blokada ma jakiekolwiek powody do wyłączenia, blokada sama w sobie zostanie uznana za wyłączoną. Blokada może być wyłączona z wielu niezależnych powodów jednocześnie, na przykład gdy użytkownik wyłączy ją ręcznie lub gdy blokada jest nieprawidłowa. | |
| setEditable(editable) | Określ, czy ten blok jest edytowalny. | |
| setFieldValue(newValue, name) | Ustawia wartość danego pola w tym bloku. | |
| setHelpUrl(url) | Ustaw adres URL strony pomocy dotyczącej tego bloku. | |
| setInputsInline(newBoolean) | Określ, czy wartości wejściowe mają być rozmieszczone poziomo czy pionowo. | |
| setMovable(movable) | Określ, czy ten blok jest przenośny. | |
| setMutator(_mutator) | Dodaj do tego bloku okno mutatora. | |
| setNextStatement(newBoolean, opt_check) | Określ, czy inny blok może być dołączony do tego bloku. | |
| setOnChange(onchangeFn) | Ustawia funkcję wywołania zwrotnego, która ma być używana, gdy zmienia się nadrzędny obszar roboczy bloku, zastępując dowolny wcześniejszy moduł obsługi onchange. Zwykle jest on wywoływany tylko z konstruktora, funkcji inicjalizatora typu bloku lub funkcji inicjalizatora rozszerzenia. | |
| setOutput(newBoolean, opt_check) | Określ, czy ten blok ma zwracać wartość. | |
| setOutputShape(outputShape) | Ustaw kształt danych wyjściowych bloku. | |
| setPreviousStatement(newBoolean, opt_check) | Określ, czy ten blok może być połączony z dolnym blokiem. | |
| setStyle(blockStyleName) | Ustaw wartości stylu i koloru bloku. | |
| setTooltip(newTip) | Ustawia tekst podpowiedzi dla tego bloku. | |
| setWarningText(_text, _opt_id) | Ustaw tekst ostrzeżenia dla tego bloku. | |
| toDevString() | Ta metoda zwraca ciąg znaków opisujący ten blok w języku deweloperów (nazwa typu i identyfikator; tylko w języku angielskim). Służy do wyświetlania błędów i logów w konsoli. Jeśli potrzebujesz ciągu znaków w języku użytkownika (w tym tekst bloku, wartości pól i bloki podrzędne), użyj funkcji toString(). |
|
| toString(opt_maxLength, opt_emptyToken) | Utwórz tekstową reprezentację tego bloku i jego elementów. | |
| unplug(opt_healStack) | Odłącz ten blok od nadrzędnego bloku. Jeśli ten blok jest oświadczeniem, opcjonalnie połącz blok pod nim z blokiem u góry. |